Method, apparatus, and system for implementing view caching in a framework to support web-based applications

ABSTRACT

According to one aspect of the present invention, a system is provided for implementing view caching in a framework to support web-based applications. The system comprising a set of server-side objects managed by an object manager (OM) running on a server. The system further comprises a set of browser-side objects running on a browser running on a client. The system also comprises a remote procedure call (RPC) mechanism and a notification mechanism to facilitate communication and synchronization between the browser-side objects and the server-side objects. The system additionally comprises a cache on the client to store layouts of views, wherein each view is a display panel consisting of a particular arrangement of applets.

CROSS-REFERENCE TO RELATED APPLICATIONS

This application is a continuation of U.S. patent application Ser. No.09/969,980 file Sep. 29, 2001, which is now U.S. Pat. No. 7,146,617,entitled “Method, Apparatus, And System For Implementing View Caching InA Framework To Support Web-Based Applications,” issued Dec. 5, 2006, andnaming Anil Mukundan, John Coker and William E. Coppens as inventors.This application is incorporated by reference herein, in its entiretyand for all purposes.

FIELD OF THE INVENTION

The present invention relates generally to the field of data processing.More specifically, the present invention relates to a method, apparatus,and system for implementing view caching in a framework to supportweb-based applications.

BACKGROUND OF THE INVENTION

As technology continues to advance and the business environments havebecome increasingly complex and diverse, more and more companies haverelied on various customer relationship management (CRM) software andeBusiness applications to conduct and manage various aspects of theirenterprise business. In general, eBusiness applications are designed toenable a company or enterprise to conduct its business over aninteractive network (e.g., Internet, Intranet, Extranet, etc.) with itscustomers, partners, suppliers, distributors, employees, etc. eBusinessapplications may include core business processes, supply chain,back-office operations, and CRM functions. CRM generally includesvarious aspects of interaction a company has with its customers,relating to sales and/or services. At a high level, customerrelationship management is focused on understanding the customer's needsand leveraging this knowledge to increase sales and improve service. CRMapplication and software is generally designed to provide effective andefficient interactions between sales and service, and unify a company'sactivities around the customer in order to increase customer share andcustomer retention through customer satisfaction.

Typically, CRM implementation strategy needs to consider the following:

Knowledge Management: one of the important factors of an effective CRMimplementation is the acquisition of information about a customer, itsanalysis, sharing and tracking. Also integral to the use of knowledgefor competitive advantage is for employees to know what actions to takeas a result of this knowledge.

Database Consolidation: another important aspect of an effective andefficient CRM solution is the consolidation of customer information in asingle database and the re-engineering of business processes around thecustomer. The goal here is to have all interactions with a customerrecorded in one place to drive production, marketing, sales and customersupport activities.

Integration of Channels and Systems: it is very important for a CRMapplication/software to provide the capability to respond to customersin a consistent and high-quality manner through their channel of choice,whether that is the e-mail, the phone, web-based user interfaces, etc.This may require the seamless integration of various communicationchannels with the customer or enterprise database. It also may requirethe integration of CRM with other parts of a company's business systemsand applications.

Technology and Infrastructure: to enhance customer services, a CRMapplication/software may include various tools to automate andstreamline online customer service. For example, a self-help modeltypically can be implemented using a combination of tools (e.g.knowledge bases with an intuitive search capability, agent technology orautomated email, etc.).

Generally, eBusiness applications are designed to allow organizations tocreate a single source of customer information that makes it easier tosell to, market to, and service customers across multiple channels,including the Web, call centers, field, resellers, retail, and dealernetworks. Advanced eBusiness applications are typically built on acomponent-based architecture and are designed to be Web-based and todeliver support for various types of clients on multiple computingplatforms including mobile clients, connected clients, thin clients, andhandheld clients, etc.

With the recent proliferation of the Web, it is desirable to provide thefunctionalities of the eBusiness applications in a Web-basedenvironment. Furthermore, it is desirable for the eBusiness applicationsoperating in a Web-based environment to retain the look-and-feel ofdesktop-based eBusiness applications with which the users are alreadyfamiliar.

BRIEF DESCRIPTION OF THE DRAWINGS

The features and advantages of the present invention will be more fullyunderstood by reference to the accompanying drawings, in which:

FIG. 1 shows a multi-layered system architecture in which the teachingsof the present invention are implemented;

FIG. 2 shows a block diagram of one embodiment of a system configurationin which the teachings of the present invention are implemented;

FIG. 3 shows a block diagram illustrating another logical representationof a multi-layered architecture in which applications can be built inaccordance with the teachings of the present invention;

FIG. 4 illustrates a block diagram of one embodiment of an applicationframework in which the teachings of the present invention may beimplemented;

FIG. 5A illustrates an exemplary framework or infrastructure 500 tosupport an interactive web client and an mobile web client of FIG. 2;

FIG. 5B illustrates an alternative view of the exemplary framework orinfrastructure shown in FIG. 5A.

FIG. 6A illustrates an exemplary configuration in which objects on thebrowser and objects managed by the object manager (OM) reside andoperate on multiple computing devices, including a client and a server;

FIG. 6B illustrates an exemplary configuration in which objects on thebrowser and objects managed by the OM reside and operate on onecomputing device;

FIG. 7 illustrates an example of how the remote procedure call (RPC)paradigm can be used to divide a program into pieces that can beexecuted on separate computing devices;

FIG. 8 illustrates an exemplary model of execution used with remoteprocedure calls;

FIG. 9 generally shows an exemplary partitioning of RPC application codesegments, RPC interfaces, client and server stubs, and the RPC runtimelibraries in the RPC client and the RPC server;

FIG. 10 generally shows an exemplary marshalling and unmarshallingbetween client data structures and server data structures;

FIG. 11 generally shows exemplary roles of RPC application codesegments, RPC interfaces, RPC stubs, and RPC runtime libraries during aremote procedure call;

FIG. 12 generally outlines an exemplary process 1200 of building adistributed RPC application;

FIG. 13 generally illustrates the linking of the local RPC runtimelibrary and the object code generated from the application code;

FIG. 14 generally illustrates an exemplary process of communicationbetween the browser-side or client-side objects and server-side objectsrunning on a multiple-devices configuration shown in FIG. 6A

FIG. 15 shows an exemplary process of communication in which thebrowser-side applet invokes the method directly on the JSSBusCompobject;

FIGS. 16, 17, and 18 illustrate examples of toolbars, application-levelmenus, and applet-level menus, respectively;

FIG. 19 shows a flow diagram of one embodiment of a process for creatingvarious objects that are used for the configuration and execution of thevarious commands;

FIG. 20 shows a flow diagram of one embodiment of a process for creatinga command object in accordance with the teachings of the presentinvention;

FIG. 21 illustrates one embodiment of the properties of a command objectaccording to the teachings of the present invention;

FIG. 22 shows a flow diagram of one embodiment of a process for creatinga toolbar object in accordance with the teachings of the presentinvention;

FIG. 23 illustrates one embodiment of the properties of a Toolbar objectaccording to the teachings of the present invention;

FIG. 24 shows a flow diagram of one embodiment of a process for creatinga toolbar item object in accordance with the teachings of the presentinvention;

FIG. 25 illustrates one embodiment of the properties of a toolbar itemobject according to the teachings of the present invention;

FIG. 26 shows a flow diagram of one embodiment of a process for creatinga menu item object in accordance with the teachings of the presentinvention;

FIG. 27 illustrates one embodiment of the properties of a menu itemobject according to the teachings of the present invention;

FIG. 28 shows a flow diagram of one embodiment of a process for creatingan applet method menu item object in accordance with the teachings ofthe present invention;

FIG. 29 illustrates the properties of an applet method menu item objectaccording to one embodiment of the present invention;

FIG. 30 shows a flow diagram of one embodiment of a process for creatinga class method menu object in accordance with one embodiment of thepresent invention;

FIG. 31 illustrates properties of a class method menu item according toone embodiment of the present invention;

FIG. 32 is a diagram illustrating the relationship between toolbarobjects, toolbar item objects, and command objects in accordance withone embodiment of the present invention;

FIG. 33 is a diagram illustrating the relationship between a menuobject, menu item objects, and command objects;

FIG. 34 is a diagram illustrating the relationship between an appletlevel menu object, applet method menu item objects, and class methodmenu item objects;

FIG. 35 illustrates a block diagram of one embodiment of a systemconfiguration 3500 in which the teachings of the present invention maybe implemented;

FIG. 36 shows a flow diagram of a process in accordance with oneembodiment of the present invention;

FIG. 37 is a flow diagram of a process according to one embodiment ofthe present invention;

FIG. 38 shows a block diagram illustrating the relationship betweenvarious objects according to one embodiment of the present invention;

FIG. 39 shows a block diagram of a logical structure of a businesscomponent in accordance with one embodiment of the present invention;

FIG. 40 shows some properties or attributes of a business componentfield in accordance with one embodiment of the present invention;

FIG. 41 shows a flow diagram of one embodiment of a process according tothe teachings of the present invention;

FIG. 42 shows a block diagram of one embodiment of a systemconfiguration according to the teachings of the present invention;

FIG. 43 is a flow diagram of a process in accordance with one embodimentof the present invention;

FIG. 44 is generally a partially block diagram of a frame orinfrastructure operating on a multiple-device configuration similar tothe configuration shown in FIG. 6A and described above in the textaccompanying FIG. 6A;

FIG. 45 generally shows the structure of an exemplary cache accordingwith one embodiment of the present invention;

FIG. 46 generally outlines an exemplary process of caching a viewaccording with one embodiment of the present invention; and

FIG. 47 generally outlines an exemplary process of switching to a viewaccording with one embodiment of the present invention.

DETAILED DESCRIPTION

In the following detailed description numerous specific details are setforth in order to provide a thorough understanding of the presentinvention. However, it will be appreciated by one skilled in the artthat the present invention may be understood and practiced without thesespecific details.

I. System Overview and Overall Architecture

In one embodiment, a system in which the teachings of the presentinvention are implemented can be logically structured as a multi-layeredarchitecture as shown in FIG. 1. In one embodiment, the logicalmulti-layered architecture as shown in FIG. 1 provides a platform forcommon services to support the various applications. These services mayinclude a user interface layer 110, an object manager layer 120, a datamanager layer 130, and a data exchange layer 140.

In one embodiment, the user Interface layer 110 may provide the applets,views, charts and reports, etc. associated with one or moreapplications. In one embodiment, various types of clients can besupported via the user interface layer 110. These various types ofclients may include traditional connected clients, remote clients, thinclients over an intranet, Java thin clients or non-Windows-basedoperating systems, and HTML clients over the Internet, etc.

In one embodiment, the object manager layer 120 is designed to manageone or more sets of business rules or business concepts associated withone or more applications and to provide the interface between the userinterface layer 110 and the data manager layer 130. In one embodiment,the business rules or concepts can be represented as business objects.In one embodiment, the business objects may be designed as configurablesoftware representations of the various business rules or concepts suchas accounts, contacts, opportunities, service requests, solutions, etc.

In one embodiment, the data manager layer 130 is designed to maintainlogical views of the underlying data and to allow the object manager tofunction independently of underlying data structures or tables in whichdata are stored. In one embodiment, the data manager 130 may alsoprovide certain database query functions such as generation of structurequery language (SQL) in real time to access the data. In one embodiment,the data manager 130 is designed to operate on object definitions in arepository file 160 that define the database schema. In one embodiment,the data storage services 170 provide the data storage for the datamodel associated with one or more applications.

In one embodiment, the data exchange layer is designed to handle theinteractions with one or more specific target databases and provide theinterface between the data manager layer 130 and the underlying datasources.

FIG. 2 shows a block diagram of one embodiment of a system configurationin which the teachings of the present invention are implemented.

In one embodiment, the multi-layered architecture allows one or moresoftware layers to reside on different machines. For example, in oneembodiment, the user interface, the object manager, and the data managercan all reside on the dedicated web clients. For other types of clientssuch as the wireless clients, in one embodiment, the object manager anddata manager can reside on a system server. It should be appreciated andunderstood by one skilled in the art that the system configuration shownin FIG. 2 is for illustrative and explanative purposes and may varydepending upon the particular implementations and applications of theteachings of the present invention.

In one embodiment, the system environment illustrated in FIG. 2 mayinclude more than one database 290. One or more subsets of the database290 can be created or replicated by a replication manager. In addition,mobile web clients can have additional remote databases (also calledlocal databases). In one embodiment, unless the remote or localdatabases associated with the mobile web clients are defined asread-only databases, these mobile web clients can create and update datalocally that will be ultimately propagated up to the primary databasewhen each mobile web client synchronizes with the system server.

In one embodiment, the database 290 is designed to store various typesof data including predefined data schema (e.g., table objects, indexobjects, etc.), repository objects (e.g., business objects andcomponents, view definitions and visibility rules, etc.), and user's orcustomer's data. In one embodiment, dedicated web clients and servercomponents, including those that operate in conjunction with the othertypes of clients, can connect directly to the database 290 and makechanges in real time. In one embodiment, mobile web clients can downloada subset of the server's data to use locally, and periodicallysynchronize with the server database through the system server to updateboth the local and the server database.

In one embodiment, various tables included in the database 290 may belogically organized into the following types: data tables, interfacetables, and repository tables, etc.

In one embodiment, data tables may be used to store user business data,administrative data, seed data, and transaction data, etc. In oneembodiment, these data tables may be populated and updated through thevarious applications and processes. In one embodiment, data tables mayinclude the base tables and the intersection tables, etc. In oneembodiment, base tables may contain columns that are defined and used bythe various applications. In one embodiment, the base tables aredesigned to provide the columns for a business component specified inthe table property of that business component. In one embodiment,intersection tables are tables that are used to implement a many-to-manyrelationship between two business components. They may also holdintersection data columns, which store information pertaining to eachassociation. In one embodiment, intersection tables provide the datastructures for association applets.

In one embodiment, interface tables are used to denormalize a group ofbase tables into a single table that external programs can interface to.In one embodiment, they may be used as a staging area for exporting andimporting of data.

In one embodiment, repository tables contain the object definitions thatspecify one or more applications regarding:

The client application configuration

The mapping used for importing and exporting data

Rules for transferring data to mobile clients

In one embodiment, the file system 295 is a network-accessible directorythat can be located on an application server. In one embodiment, thefile system 295 stores the physical files created by variousapplications, such as files created by third-party text editors, andother data that is not stored in the database 290. In one embodiment,physical files stored in the file system 295 can be compressed andstored under various naming conventions. In one embodiment, dedicatedweb clients can read and write files directly to and from the filesystem 295. In one embodiment, mobile web clients can have a local filesystem, which they synchronize with the server-based file system 290periodically. In one embodiment, other types of client such as thewireless clients and the web clients can access the file system 290 viathe system server.

In one embodiment, the enterprise server 250 is a logical grouping ofthe system servers 255 that share a common table owner or a database,point to a common gateway Server, and can be administered as a groupusing server manager 260. In one embodiment, the connection to thegateway server can be established via TCP/IP. In one embodiment, theenterprise server 250 can be scaled effectively by deploying multiplesystem servers 255 in the enterprise server 250, thus providing a highdegree of scalability in the middle tier of applications.

In one embodiment, the server 255 runs one or multiple server programs.It handles the incoming processing requests and monitors the state ofall processes on the server. In one embodiment, server programs aredesigned and configured to perform one or more specific functions orjobs including importing and exporting data, configuring the database,executing workflow and process automation, processing to support mobileweb clients for data synchronization and replication, and enforcingbusiness rules, etc. In one embodiment, the server 255 can be an NTService (under Windows NT operating system) or a daemon (e.g., abackground shell process) under UNIX operating system. In oneembodiment, the server 255 supports both multi-process andmulti-threaded components and can operate components in batch, service,and interactive modes.

In one embodiment, the server manager 260 is configured as a utilitythat allows common control, administration and monitoring acrossdisparate programs for the servers 255 and the enterprise server 250. Inone embodiment, the server manager 260 can be used to perform thefollowing tasks: start, stop, pause, and resume servers 255, components,and tasks; monitor status and collect statistics for multiple tasks,components, and servers within an enterprise server; and configure theenterprise server, individual servers individual components, and tasks,etc.

In one embodiment, the gateway server can be configured as a logicalentity that serves as a single entry point for accessing servers. In oneembodiment, it can be used to provide enhanced scalability, loadbalancing and high availability across the enterprise server. In oneembodiment, the gateway server may include a name server and aconnection brokering component. In one embodiment, the name server isconfigured to keep track of the parameters associated with the servers.For example, the availability and connectivity information associatedwith the servers can be stored in the name server. The variouscomponents in the system can query the name server for variousinformation regarding the servers' availability and connectivity. In aWindows NT environment, the name server can be run as a NT service. In aUNIX environment, the name server can run as a daemon process. In oneembodiment, the connection brokering component is used to perform loadbalancing function such as directing client connection requests to anappropriate server (e.g., the least-busy server).

In one embodiment, as illustrated in FIG. 2, the various types ofclients that can be supported by the system may include the followingclients: dedicated web clients, mobile web clients, web clients,wireless clients, and handheld clients, etc.

In one embodiment, dedicated web clients (also called connected clients)are connected directly to a database server for data access via a LAN orWAN connection. In one embodiment, these connected or dedicated webclients do not store data locally. These dedicated web clients can alsoaccess the file system directly. In one embodiment, the user interface,the object manager, and the data manager layers of the multi-layeredarchitecture reside on the dedicated web client.

In one embodiment, the mobile web clients are designed and configuredfor local data access and thus can have their own local database and/orlocal file system. In one embodiment, mobile web clients can interactwith other components within the system via the gateway server. Throughsynchronization, the modifications from the local database and theserver database can be exchanged. Mobile web clients are described inmore detail below. In one embodiment, a web client runs in a standardbrowser format from the client's machine. In one embodiment, the webclient can connect to a system server 255 through a web server. In oneembodiment, the system server 255 is designed and configured to executebusiness logic and access data from the database 290 and file system295. In one embodiment, the web client described herein is designed andconfigured in accordance with the teachings of the present invention tooperate in an interactive mode. In one embodiment, the interactive webclient framework as described herein utilizes dynamically createdobjects implemented in JavaScript on the browser side that correspond toobjects on the server side. In one embodiment, these dynamically createdobjects on the browser side may include the current view and itscorresponding applets, the current business object and the correspondingbusiness components, etc. The web client is described in more detailsbelow.

In one embodiment, wireless clients are essentially thin clients enabledon wireless devices. The wireless clients can use a wireless applicationprotocol (WAP)-based user interface to communicate and exchangeinformation/data with the system server. The system configurationillustrated in FIG. 2 is described in more details below with referencesto various structures, databases, tables, file systems, etc. asillustrating examples.

FIG. 3 shows a block diagram illustrating another logical representationof a multi-layered architecture in which applications can be built inaccordance with the teachings of the present invention. Again, themulti-layered architecture as illustrated in FIG. 3 provides theplatform for various common services designed and configured to supportthe various applications. In one embodiment, these various services mayinclude presentation services logic layer 315 which corresponds to anapplet manager and user interface layer 310, application serviceslogical layer 325 which corresponds to an object manager (OM) layer 320and a data manager (DM) layer 330, and data services logical layer 345which corresponds to a database layer 340.

In one embodiment, the presentation services 315 may be designed andconfigured to support various types of clients and may provide them withuser interface applets, views, charts, and reports, etc. As describedabove, a large variety of clients may be supported including wirelessclients, handheld clients, web clients, mobile web clients, anddedicated (connected) clients, etc.

In one embodiment, the application services 325 may include businesslogic services and database interaction services. In one embodiment,business logic services provide the class and behaviors of businessobjects and business components. In one embodiment, database interactionservices may be designed and configured to take the user interface (UI)request for data from a business component and generate the databasecommands (e.g. SQL queries, etc.) necessary to satisfy the request. Forexample, the data interaction services may be used to translate a callfor data into DBMS-specific SQL statements.

In one embodiment, data storage services 345 may be designed andconfigured to provide the data storage for the underlying data modelwhich serves as the basis of the various applications. For example, thedata model may be designed and configured to support various softwareproducts and applications including call center, sales, services, andmarketing, etc., as well as various industry vertical products andapplications such as eFinance, eInsurance, eCommunications, andeHealthcare, etc.

FIG. 4 illustrates a block diagram of one embodiment of an applicationframework in which the teachings of the present invention may beimplemented. As illustrated in FIG. 4, the application framework mayinclude various logical groupings of various types of services andvarious types of tools that can be used to design and configureparticular applications based on business needs and environments.

In one embodiment, the core services are designed and configured toprovide the framework in which the applications execute. In oneembodiment, the core services may include the following:

The enterprise server, which is the middle-tier application server

The networks that link all of these pieces together

Facilities like event manager and data replication, which allow sharingdata between multiple installations of various applications as well asbetween the various applications and other external applications

The authentication and access control, the security facilities.

In one embodiment, application integration services may be designed andconfigured to allow the various applications built in accordance withthis framework to communicate with the external world. In oneembodiment, the various types of services in this logical grouping maybe designed and configured to provide for real-time, near-real-time, andbatch integration with external applications. For example, theseintegration services may be used to enable communications betweenexternal applications and the internal applications using availablemethods, technologies, and software products. In one embodiment,application integration services allow the systems or applications toshare and replicate data with other external enterprise applications.Accordingly, these services allow a particular application or system tobe both a client requesting information, and a server having informationrequested from it.

In one embodiment, business processes services are designed andconfigured to allow the client to automate business processes throughthe application. In one embodiment, these various business processservices may include the following:

Assignment of tasks through Assignment Manager

Enforcement of business practices through Workflow Manager

Reuse of custom business logic through Business Services

Ensuring proper product configuration and pricing through the ProductConfigurator and Pricing Configurator

In one embodiment, creation of these business processes can be donethrough Run-Time tools such as Personalization Designer, WorkflowDesigner, SmartScript Designer, Assignment Administration Views, and theModel Builder, etc.

In one embodiment, integration services may be designed and configuredto provide the client with user interface and thin client support. Inone embodiment, these may include capabilities for building andmaintaining web-based applications, providing web support facilitiessuch as user Profile Management, Collaboration Services and Email andFax services, as well as advanced Smart Scripting, etc.

In one embodiment, design time tools may be designed and configured toprovide the services to customize, design, provide integration points,and maintain the application. These various tools provide one commonplace to define the application.

In one embodiment, admin services are designed and configured provideone place to monitor and administer the application environment. In oneembodiment, these services allow the user to administer the applicationeither through a graphic user interface (GUI) or from a command line,etc.

II. System Framework or Infrastructure

FIG. 5A illustrates an exemplary system framework or infrastructure 500to support an interactive web client 205 and a mobile web client 210 ofFIG. 2 in accordance with one embodiment of the present invention. FIG.5B illustrates an alternative view of the exemplary system framework orinfrastructure 500 shown in FIG. 5A.

The framework or infrastructure 500 can support the interactive webclient 205 (shown in FIG. 2) and the mobile web client 210 (also shownin FIG. 2), and is capable of meeting certain criteria, such asincreasing the interactivity and performance of the web client and themobile web client, and reducing the number of page refreshes for commonactions.

The framework or infrastructure 500 can include objects 502 that can bedynamically created on the browser to mimic corresponding objects 504managed by the object-manager. In one embodiment, the objects 504managed by the object manager (OM) can be built using a programminglanguage, such as C+++, supporting the object-oriented paradigm.

As shown in FIGS. 5A and 5B, exemplary objects 504 managed by the OM caninclude an object 506 representing a view, CSSWEView 506. A view isgenerally a display panel consisting of a particular arrangement ofapplets. In one embodiment, one active view can be displayed at anygiven time. Another exemplary object managed by the OM can be an object508 representing an applet, CSSWEApplet 508. An applet is generally avisual application unit that appears on the screen as part of a view.Other exemplary objects managed by the OM can include an object 510representing a business component (CSSBusComp 510), an object 512representing a business object (CSSBusObj 512), and an object 514representing a frame (CSSWEFrame 514). In one embodiment, the businessobject may be designed as configurable software representations of thevarious business rules or concepts such as accounts, contacts,opportunities, service requests, solutions, etc. In this embodiment, thebusiness components typically provide a layer of wrapping over tables,and the applets reference business components rather than the underlyingtables. In addition, a frame is generally a sub-component of a view andmay comprise of one or more applets.

In one embodiment, objects 502 on the browser can be built usingJavaScript. As shown in FIGS. 5A and 5B, exemplary objects 502 on thebrowser side may include JSSBusObj 516, JSSBusComp 518, JSSView 520, andJSSApplet 522 to respectively mirror CSSBusObj 512, CSSBusComp 510,CSSWEView 506, and CSSWEApplet 508, which are objects 504 managed by theOM.

Objects 502 on the browser and objects 504 managed by the OM can beconfigured to reside and operate on one computing device or multiplecomputing devices. FIG. 6A illustrates an exemplary configuration 600 inwhich objects 502 on the browser and objects 504 managed by the OMreside and operate on multiple computing devices 602,604, including aclient 602 and a server 604. FIG. 6B illustrates an exemplaryconfiguration 650 in which objects 502 on the browser and objects 504managed by the OM reside and operate on one computing device 652.

Returning to FIGS. 5A and 5B, objects 502 on the browser are generallysynchronized with corresponding or mirrored objects 504 managed by theOM. Synchronization can be accomplished through a remote procedure call(RPC) mechanism 528 and a notification mechanism 530. The RPC mechanism528 and the notification mechanism 530 will be described below in moredetails.

Of the objects 502 on the browser, the JSSApplication object 524typically exists throughout a user-session. The JSSApplication object524 should be initially loaded when the user starts an application. Anapplication would generally be started when the user invokes a subset ofthe application from an icon on the desktop or from the Start menu. TheJSSApplication object 524 generally performs a role similar to that ofthe CSSModel object 534. The CSSModel object 534 is generally a globalsession object that provides access to repository objects that are inuse, the current business object instance in memory, the relationshipsbetween the current business object and the business componentscontained in it, and the user's global state information. The CSSModelobject 534 generally accesses a repository 532 to obtain neededinformation. The repository 532 is generally a set of object definitionsused to define an application or a suite of applications. However, theJSSApplication object 524 is generally scaled down to track one view,applets associated to the tracked view, one business object, and thebusiness components that are in use in the view.

Unlike the JSSApplication object 524, the JSSView object 520, theJSSApplet object 522, the JSSBusObj object 516 and the JSSBusComp object518 are typically temporary or impermanent entities, and are generallyreplaced when a page refresh occurs. For example, a request to navigateto a new view may cause a new set of JSSView 520, JSSApplet 522,JSSBusObj 516, and JSSBusComp 518 objects to be created to run on thebrowser.

Accordingly, objects 502 on the browser can be generally described aslightweight representations of mirrored or corresponding objects 504managed by the OM. Each object 502 on the browser would typicallyinclude a subset of the functionalities included in correspondingobjects 504 managed by the OM. For example, the JSSView object 520,similar to a CSSView object 506, generally represents a collection ofapplets. The JSSBusObj object 516, similar to a CSSBusObj object 512,generally manages the various one-to-many relationships between activebusiness components so that correct relationships are employed whenthese active business components are populated via queries. TheJSSBusObj object 516 generally exists on the browser for the life of thecurrent view, and should be kept in sync with the correspondingCSSBusObj object 512.

In one embodiment, when the browser submits a request to navigate to anew view to the web engine 526, the web engine 526 would send a responsecontaining the view layout that is devoid of data. Then the web engine526 would send a response containing a string of data to populate theview.

The JSSApplication object 524 generally manages communications flowinginto and out from objects on the browser. In one embodiment, a methodinvoked on an object on the browser would typically be directed to theJSSApplication object 524 if the invoked method should be retargeted toan object 504 managed by the OM. The JSSApplication object 524 wouldgenerally use the RPC mechanism 528 to route the invoked method throughthe web engine 526 to the appropriate object 504 managed by the OM. Theweb engine 526 would typically be employed to send return notificationsand data from objects 504 managed by the OM to objects 502 on thebrowser. The web engine 526 would generally use the notificationmechanism 530 to route notifications and data through the JSSApplicationobject 524 to objects 502 on the browser.

The browser objects 502 generally use the remote procedure calls 528 toinvoke methods on the objects 504 managed by the OM. These remoteprocedure calls 528 are generally packaged as HTTP requests. Responsesfrom the objects 504 managed by the OM are packaged as HTTP responsescontaining notifications and associated status information and data. Inone embodiment, remote procedure calls are made with blocking enabled toensure synchronization between the objects 502 on the browser and theobjects 504 managed by the OM. With blocking enabled, control wouldtypically not be passed back to the calling code until the called remoteprocedure finishes executing.

Remote Procedure Call (RPC)

The RPC model generally uses the same procedural abstraction as aconventional program, but allows a procedure call to span the boundarybetween two computers. FIG. 7 illustrates an example of how the RPCparadigm can be used to divide a program 700 into pieces that can beexecuted on separate computing devices 702,704. This figure generallyshows a distributed program having multiple procedures. Main( ) 706,proc_1( ) 708, proc_2( ) 710, proc_3( ) 712, proc_5( ) 714, proc_6( )716, and proc_7( ) 718 reside and operate in the first computing deviceor the client 702; and proc_4( ) 720 and proc_8( ) 722 reside andoperate in the second computing device or the server 704. A solid line724 from procedure n to procedure m denotes a call from n to m. A dashedline 726 shows how control passes from one computing device to anothercomputing device during a remote procedure call.

FIG. 8 illustrates an exemplary model 800 of execution used with remoteprocedure calls. In this figure, solid lines 724 are generally used todenote flow control within a computing device; and dashed lines 726 aregenerally used to show how control passes from one computing device toanother computing device during a remote procedure call.

As such, a remote procedure call generally executes a procedure locatedin a separate address space from the calling code. The RPC model isgenerally derived from the programming model of local procedure callsand takes advantage of the fact that every procedure contains aprocedure declaration. The procedure declaration defines the interfacebetween the calling code and the called procedure. The proceduredeclaration defines the call syntax and parameters of the procedure.Calls to a procedure should typically conform to the proceduredeclaration.

Applications that use remote procedure calls look and behave much likelocal applications. However, an RPC application is divided into twoparts: a server, which offers one or more sets of remote procedures, anda client, which makes remote procedure calls to RPC servers. A serverand its client(s) generally reside on separate systems and communicateover a network. RPC applications depend on the RPC runtime library tocontrol network communications for them. The RPC runtime librarygenerally supports additional tasks, such as finding servers for clientsand managing servers.

A distributed application generally uses dispersed computing resourcessuch as central processing units (CPU), databases, devices, andservices. The following applications are illustrative examples ofdistributed applications:

A calendar-management application that allows authorized users to accessthe personal calendars of other users;

A graphics application that processes data on CPUs and displays theresults on workstations; and

A manufacturing application that shares information about assemblycomponents among design, inventory, scheduling, and accounting programslocated on different computers.

RPC software should generally meets the basic requirements of adistributed application including:

Clients finding the appropriate servers;

Data conversion for operating in a heterogeneous environment; and

Network communications

Distributed applications include tasks such as managing communications,finding servers, providing security, and so forth. A standalonedistributed application needs to perform all of these tasks itself.Without a convenient mechanism for these distributed computing tasks,writing distributed applications is difficult, expensive, anderror-prone.

RPC software typically provides the code, called RPC stubs, and the RPCruntime library that performs distributed computing tasks forapplications. The RPC stubs and the RPC runtime library should be linkedwith client and server application code to form an RPC application.

Table 1 generally shows the basic tasks for the client and server of adistributed application. Calling the procedure and executing the remoteprocedure, shown in italicized text, are performed by the applicationcode Oust as in a local application) but here they are in the client andserver address spaces. As for the other tasks, some are performedautomatically by the stubs and RPC runtime library, while others areperformed by the RPC runtime library via API calls in the applicationcode.

TABLE 1 Basic Tasks of an RPC Application Client Tasks Server Tasks 1.Select network protocols 2. Register RPC interfaces 3. Registerendpoints in endpoint map 4. Advertise RPC interfaces and objects in thenamespace 5. Listen for calls 6. Find compatible servers that offer theprocedures 7. Call the remote procedure 8. Establish a binding with theserver 9. Convert input arguments into network data 10. Transmitarguments to the server's runtime 11. Receive call 12. Disassemblenetwork data and convert input arguments into local data 13. Locate andinvoke the called procedure 14. Execute the remote procedure 15. Convertthe output arguments and return value into network data 16. Transmitresults to the client's runtime 17. Receive results 18. Disassemblenetwork data and convert output arguments into local data 19. Returnresults and control to calling code

FIG. 9 generally shows an exemplary partitioning 900 of RPC applicationcode segments 904 and 914, RPC interfaces 906 and 916, client and serverstubs 908 and 918, and the RPC runtime libraries 910 and 920 in the RPCclient 902 and the RPC server 904.

The RPC client 902 or the RPC server 912 typically contains RPCapplication code segments 904 and 914, RPC interfaces 906 and 916, stubs908 and 918, and the RPC runtime libraries 910 and 920. The RPCapplication code segments 904,914 are generally the code written for aspecific RPC application by the application developer. The RPCapplication code segments 904,914 generally implement and call remoteprocedures, and also calls needed routines or procedures in the RPCruntime library. An RPC stub 908,918 is generally an interface-specificcode module that uses an RPC interface 906,916 to pass and receivearguments. A client 902 and a server 912 typically contain complementaryRPC stubs 906,916 for each shared RPC interface 906,916. The RPC runtimelibrary 910,920 generally manages communications for RPC applications.In addition, the RPC runtime library 910,920 should support anApplication Programming Interface (API) used by RPC application code toenable RPC applications to set up their communications, manipulateinformation about servers, and perform optional tasks such as remotelymanaging servers and accessing security information.

RPC application code segments 904,914 usually differ for clients andservers. RPC application code 914 on the server 912 typically containsthe remote procedures that implement one RPC interface. RPC applicationcode 904 on the corresponding client 902 typically contains calls tothose remote procedures.

RPC stubs 908,918 generally perform basic support functions for remoteprocedure calls. For instance, RPC stubs 908,918 prepare input andoutput arguments for transmission between systems with different formsof data representation. RPC stubs 908,918 use the RPC runtime library910,920 to handle the transmission between the client 902 and server904. RPC stubs 908 on the client 902 can also use the local RPC runtimelibrary 910 to find appropriate servers for the client 902.

FIG. 10 generally shows an exemplary marshalling and unmarshallingbetween client data structures and server data structures. When theclient RPC application code calls a remote procedure, the client RPCstub 908 should prepare the input arguments 1002 for transmission. Theprocess for preparing arguments for transmission is known as“marshalling.”

Marshalling 1004 generally converts input or call arguments 1002 into abyte-stream format and packages them for transmission. Upon receivingcall arguments, a server RPC stub 918 unmarshalls 1014 them.Unmarshalling 1014 is generally the process by which a stub disassemblesincoming network data and converts it into application data using aformat that the local system understands. Marshalling 1004,1016 andunmarshalling 1014,1006 both occur twice for each remote procedure call.The client RPC stub 908 marshalls 1004 input arguments 1002 andunmarshalls 1006 output arguments 1008. The server RPC stub 918unmarshalls 1014 input arguments 1006 and marshalls 1016 outputarguments 1008. Marshalling and unmarshalling permit client and serversystems to use different data representations for equivalent data. Forexample, the client system can use ASCII data 1002,1008 and the serversystem can use Unicode data 1018 as shown in FIG. 10.

The IDL compiler (a tool for application development) generates stubs bycompiling an RPC interface definition written by application developers.The compiler generates marshalling and unmarshalling routines forplatform-independent IDL data types. To build the client for an RPCapplication, a developer links client application code with the clientstubs of all the RPC interfaces the application uses. To build theserver, the developer links the server application code with thecorresponding server stubs.

In addition to one or more RPC stubs, each RPC server and RPC clientshould be linked with a copy of the RPC runtime library. The RPC runtimelibrary generally provides runtime operations such as controllingcommunications between clients and servers and finding servers forclients on request. RPC stubs in the client and the server typicallyexchange arguments through the RPC runtime library that is respectivelylocal to the client and the server. The RPC runtime library on theclient typically transmits remote procedure calls to the server. The RPCruntime library on the server generally receives the remote procedurecalls from the client and dispatches each call to the appropriate RPCstub on the server. The RPC runtime library then sends the results ofeach call to the RPC runtime library on the client.

RPC application code on the server must also contain serverinitialization code that calls routines in the RPC runtime library onthe server when the server is starting up and shutting down. RPCapplication code on the client can also call RPC runtime libraryroutines for initialization purposes. Furthermore, RPC application codeon the server and RPC application code on the client can also containcalls to RPC stub-support routines. RPC stub-support routines generallyallow applications to manage programming tasks such as allocating andfreeing memory.

FIG. 11 generally shows exemplary roles of RPC application code segments904 and 914, RPC interfaces 906 and 916, RPC stubs 908 and 918, and RPCruntime libraries 910 and 920 during a remote procedure call. Theclient's application code or calling code 908 invokes a remote procedurecall, passing the input arguments 1002 through the client's RPCinterface 906 to the client stub 908. The client stub 908 marshalls theinput arguments 1002 and dispatches the call to the client's RPC runtimelibrary 910. The client's RPC runtime library 910 transmits the inputarguments 1002 to the server's RPC runtime library 920, which dispatchesthe call to the server stub 918 for the RPC interface 916 of the calledprocedure. The server's stub 918 unmarshalls the input arguments 1002and passes them to the called remote procedure 914. The server'sapplication code or remote procedure 914 executes and then returns anyoutput arguments 1008 to the server stub 918. The server stub 918marshalls the output arguments 1008 and returns them to the server's RPCruntime library 920. The server's RPC runtime library 920 transmits theoutput arguments 1008 to the client's RPC runtime library 910, whichdispatches them to the client stub 901. The client's stub 908unmarshalls output arguments 1008 and returns them to the calling code904.

In one embodiment, remote procedure calls are made with blocking enabledto ensure synchronization between the objects 502 on the browser and theobjects 504 managed by the OM (shown in FIGS. 5A and 5B). With blockingenabled, control would typically not be passed back to the calling codeuntil the called remote procedure finishes executing.

FIG. 12 generally outlines an exemplary process 1200 of building adistributed RPC application. The process generally includes thefollowing basic tasks:

Designing the application, deciding what procedures are needed and whichof the needed procedures will be remote procedures, and deciding how theremote procedures will be grouped into RPC interfaces (block 1205);

Using the Universal Unique Identifier (UUID) generator to generate aUUID for each of the RPC interfaces (block 1210);

Using the Interface Definition Language (IDL) to describe the RPCinterfaces for planned data types and remote procedures (block 1215);

Generating the client and server stubs by compiling the IDL descriptionusing an IDL compiler (block 1220);

Writing or modifying application code using a programming language thatis compatible with the RPC stubs, so that the application code workswith the stubs (block 1225);

Generating object code from application code (block 1230); and

Linking the local RPC runtime library and the object code generated fromthe application code to generate executable code (block 1235).

FIG. 13 generally illustrates the linking of the local RPC runtimelibrary and the object code generated from the application code. For theclient, object code of the client stub 908, the client application codeor calling code 904, and the client's RPC runtime library 910 are linkedusing a linker 1302 to generate the client executable code 1304. For theserver, object code for the server stub 918, the server's initializationcode 1308, the server's application code or remote procedures 914, andthe server's RPC runtime library 916 are linked using the linker 1302 togenerate the server executable code 1306.

Traditionally, calling code and called procedures share the same addressspace. In an RPC application, the calling code and the called remoteprocedures are not linked; rather, they communicate indirectly throughan RPC interface. An RPC interface is generally a logical grouping ofoperations, data types, and constants that serves as a contract for aset of remote procedures. RPC interfaces are typically compiled fromformal interface definitions written by application developers using theInterface Definition Language (IDL).

In developing a distributed application, an interface definition shouldbe defined in IDL. The IDL compiler generally uses the interfacedefinition to generate a header file, a client stub file, and a serverstub file. The IDL compiler can produce header files in a standardprogramming language, and stubs as source files or as object file. Forsome applications, an Attribute Configuration File (ACF) accompanyingthe interface definition may be defined. If an ACF exists, the IDLcompiler interprets the ACF when it compiles the interface definition.Information in the ACF is used to modify the code that the compilergenerates.

The header of each RPC interface typically contains a Universal UniqueIdentifier (UUID), which is a hexadecimal number that uniquelyidentifies an entity. A UUID that identifies an RPC interface isgenerally known as an interface UUID. The interface UUID ensures thatthe interface can be uniquely identified across all possible networkconfigurations. In addition to an interface UUID, each RPC interfacecontains major and minor version numbers. Together, the interface UUIDand version numbers form an interface identifier that identifies aninstance of an RPC interface across systems and through time.

Notifications

Returning to FIGS. 5A and 5B, objects 502 on the browser are generallysynchronized with corresponding or mirrored objects 504 managed by theOM so that changes can be reflected. Synchronization can be accomplishedthrough a remote procedure call (RPC) mechanism 528 and a notificationmechanism 530.

The notification mechanism 530 generally provides the means by whichdata in an object 502 on the browser (e.g., JSSBusComp 518) can beupdated when data or status is changed in a corresponding object 504managed by the OM (e.g., CSSBusComp 510). In one embodiment, theCSSSWEView object 506 would collect one or more notifications, and sendthem to the objects 502 on the browser at the end of a view show cycle.

In one embodiment, the following exemplary or illustrative notificationscan be transmitted. It should be noted that some of the notificationslisted below require parameters. In other cases, the framework canunderstand the context for these notifications by simply knowing itscurrent state.

NotifyBeginNotifys—Indicates the start of a set of notifications.

NotifyEndNotifys—Indicates the end of a set of notifications

NotifyStateChanged—Indicates that there has been a change of state. Anexemplary scenario in which a change of state may occur is when thesystem goes into a query state (where the user can enter queryconditions execute a query), and then goes into a commit pending state(where the user can update the data values).

NotifyBeginQuery—Indicates that the business component is in a stateready to accept query conditions

NotifyExecute—Indicates that the business component has been executed(i.e., has executed a query on the database and repopulated itself withfresh data). This notification can include an optional parameter toprovide query specifications.

NotifyEndQuery—Indicates that a query has been completed.

NotifyDeleteRecord—Indicates that a record has been deleted from thedatabase.

NotifyDeleteWorkSet—Indicates that a record has been removed from theworking set. This notification can include a parameter that provides theindex of the working set row that needs to be removed.

NotifyInsertWorkSet—Indicates that a record has been added to thecurrent working set. This notification can include parameters to providethe index of the new record in the working set.

NotifyInsertWSFieldVals—Indicates that certain value(s) need to be addedto a field in the working set.

NotifyNewActiveField—Indicates that a new field is active or current.

NotifyNewActiveRow—Indicates that a new row (i.e., record) is active orcurrent.

NotifyNewData—Indicates that there has been change(s) in the data.

NotifyNewData WS—Indicates that there has been change(s) in the data inthe working set.

NotifyNewFieldData—Indicates that a particular field has new data. Thisnotification includes parameter that provides the name of the field.

NotifyNewFieldQuerySpec—Indicates that a particular field has a newquery or search specification.

NotifyNewPrimary—Indicates that a new record has become the primaryrecord.

NotifyNewRecord—Indicates that a new record has been created.

NotifyNewRecordData—Indicates that a newly created record has new data.

NotifyNewRecordData WS—Indicates that a newly created record has newdata that to be populated into the working set.

NotifyNewSelection—Indicates the selection and de-selection of a record.

NotifyNewSelIds—Indicates the selection of multiple records.

NotifyPageRefresh—Indicates that the UI needs to be refreshed. Thisnotification is typically used when a generally substantial change inthe UI is required rather than just updating data. This notification cancause a server trip to fetch a new page and display it in the browser.

NotifyScrollData—Indicates that the records need to be scrolled up ordown. Certain User Interface objects, such as list applets, can use thisnotification to scroll up and down to show different rows.

NotifyChangeSelection—Indicates that there has been a change in recordselection (i.e., the current row has either been selected ordeselected).

NotifySelModeChange—Indicates a change in the selection mode. In oneembodiment, there can be two modes of selection, including (i) selectionof one record at a time and (ii) selection of multiple recordssimultaneously (e.g., deleting multiple records with one command).

Notify TotalsChanged—Indicates that total values need to be changed. Insome cases when multiple records are displayed, some fields may alsodisplay the summation of values in all the records. This notificationindicates that total value has changed.

NotifyLongOpProgress—Indicates that a long (i.e. time consuming) actionis in progress. This notification is used by the User Interface toprovide feedback to the user, such as showing a progress or status barshowing how much of the task is currently complete.

NotifyGeneric—This is a generic notification used to notify the UserInterface object of some special conditions that are not covered by setof notifications listed and described above. Each type of genericnotification can include a parameter providing a name for the genericnotification so that one type of generic notification can bedistinguished from another type of generic specification. Each type ofgeneric notification can include its unique parameters.

General Communication Processes

As stated above, objects on the browser and objects managed by the OMcan be configured to reside and operate on one or multiple computingdevices. As shown above, FIG. 6A illustrates an exemplary configuration600 in which objects 502 on the browser and objects 504 managed by theOM reside and operate on multiple computing devices 602 and 604,including a client 602 and a server 604. FIG. 6B illustrates anexemplary configuration 650 in which objects 502 on the browser andobjects 504 managed by the OM reside and operate on one computing device652.

FIG. 14 generally illustrates an exemplary process 1400 of communicationbetween the browser-side or client-side objects 502 and server-sideobjects 504 running on a multiple-device configuration 600 shown in FIG.6A. The exemplary process 1400 of communication of FIG. 14 is typicallyby user input and is handled first at browser-side applet, JSSApplet(block 1405). When the user clicks on a link or other user interfacefeature, an invoke method is generated. The JSSApplet is typically thefirst object to receive the generated invoke method (block 1410). TheJSSApplet can then issue a remote procedure call, by way of theJSSApplication, to retarget the invoke method to the server-side applet,CSSWEApplet (block 1415). The targeted server-side applet, CSSWEApplet,can generally respond to an RPC invoke method from the browser-sideapplet, JSSApplet, by setting a status flag (block 1420). In oneembodiment, the status flag can be set to one the following values:

Continue—This value generally indicate that the server-side applet,CSSWEApplet, has performed its share of handling the invoke method (orhas no role to perform), and that the JSSApplet on the browser needs tocomplete the action. Notifications are provided in the response, but areoften empty.

Completed—This value generally indicates that the server-side applet hascompleted the handling of the invoke method, and that the browser needsto perform no further action other than to respond to notificationsprovided in the response.

NewPage—This value generally indicates that the response to the invokerequest or other command requires a page refresh on the browser,including re-a generation all the temporary browser-side objects. A URLis sent to the browser, so that the new page can be obtained. However,there will no notifications. This value is typically set in cases suchas when a drilldown to a different view is requested.

Error—This value generally indicates that the invoke method requestfailed. Upon receiving an Error status, the JSSApplet would typicallydisplay an error page.

When a browser-side applet, JSSApplet, calls the server through the RPC,the browser-side applet typically looks at the status flag in theresponse and then handles it (block 1425). If the returned status isError, the browser-side applet would show an error page. If the returnedstatus is Completed, the server is generally indicating that it hadalready handled the invoke method and that there's nothing left for thebrowser to do. If the returned status is Continue, the server isgenerally indicating that it is not handling the invoke method. Thebrowser-side applet would generally respond to a returned status ofContinue by redirecting the method to a JSSBusComp object by invokingthe method directly on a JSSBusComp object. The JSSBusComp object may beable to satisfy the invoke method request, or may have to send its ownRPC call through the JSSApplication to its corresponding server-sidebusiness component.

FIG. 15 shows an exemplary process 1500 of communication in which thebrowser-side applet invokes the method directly on the JSSBusCompobject. It should be noted that the process 1500 of FIG. 15 will bedescribed below as though the process had occurred in a multiple-deviceconfiguration shown in FIG. 6A. In block 1505, the browser-side applet,JSSApplet, redirects the method to the JSSBusComp object. In block 1510,the client-side business component object, JSSBusComp, would then issuea remote procedure call, through JSSApplication object, to a server-sidebusiness component, CSSBusComp. The server-side business componentgenerally processes the RPC method call, sets and sends back a status,and also returns a set of notifications in appropriate cases (block1515). In one embodiment, the status flag can have the following values:

Completed—This value generally indicates the server-side businesscomponent, CSSBusComp, had generally processed the invoke methodsuccessfully. Notifications will typically occur.

Error—This value generally indicates that the server-side businesscomponent, CSSBusComp, had unsuccessfully processed the invoke methodcall. Upon receiving a returned status of Error, the browser wouldtypically display an error page.

In block 1520, the client-side business component (JSSBusComp) examinesthe returned status flag and responds appropriately. It should be notedthat the server will be contacted if an invoke method call performsactions that would require synchronization between the browser andserver business components. It should be further noted that there couldbe circumstances where the JSSBusComp object may be able to handle therequest locally without needing to contact the server. An example ofsuch circumstances is when the user performs a next record operation andthen a previous record operation without changing any data.

Methods Potentially Supported by Browser-Side Objects

In one embodiment, the methods, which can be potentially supported bythe browser-side objects, can be divided into the following categories:base object methods, application methods, business component methods,service methods, and applet methods. For illustrative purposes,exemplary methods in each category will be listed and general describedbelow.

Most of the browser-side objects will typically inherit the followingbase object methods:

AddErrorMsg(errcode, params, append)

General Description: Adds an error message to the error chain for thecurrent object.

AddErrorMsgText(errCode, errMsg, append)

General Description: Adds an error message to the error chain for thecurrent object.

ClearErrorMsg( )

General Description: Clears out the error chain for the current object.

CopyErrorMsg(inputObject)

General Description: Copies the error chain from the passed object,inputobject, to the current object.

FormatString(format, parameters)

General Description: Substitutes parameters into the format by replacing“% W’ escapes in the format with the equivalent parameter as specifiedin the params array.

GetApplication( )

General Description: Returns the global application object.

GetErrorCode( )

General Description: Returns the top-most error code in the error chain.An error code is generally a string. An empty string typically indicatesthat there is no error.

GetErrorCount( )

General Description: Returns the length of the error chain for thecurrent object.

GetErrorMsg(index)

General Description: Returns the nth error message text string from theerror chain for the current object. Note that the index is zero-based.

GetNthErrorCode(index)

General Description: Returns the nth error code from the error chain forthe current object.

HasErrorMsg( )

General Description: Checks to see whether the current object has anyregistered errors.

LockErrorMsg( )

General Description: Prevents additional errors from being registered orcleared for the current object.

SetErrorMog(errCode, params, child)

General Description: Registers an error on the current object. ErrCodeis generally a key registered in the message table and mapped to anerror message format string. Params can be null if the format takes noparameters, an array containing the string parameter values, or a singlevalue substituted for “%1”.SetErrorMsgText(errCode, errMsg)General Description: Registers an error on the current object.TextToHTML(text)General Description: Returns an HTML safe string for the inputted text.TranslateError(errCode, params)General Description: Returns a formatted string for the specifiedmessage key and parameters.UnLockErrorMsg( )General Description: Resumes handling error registration and clearing onthe current object.

In one embodiment, each browser-side application object can typicallysupport the following application methods:

AddBusobj(busObj)

General Description: Adds the BusObj for a view being instantiated.Called only by SWE.

AddRowCounterTemplate(key, templ)

General Description: Adds the string format template for one of thepossible row counter formats.

Add View(view)

General Description: Adds a new view object.

CanInvokeMethod(name)

General Description: Verifies whether a given method can be invoked.

ClosePOPUP( )

General Description: Closes the active popup applet/control.

CreateOb(jssObjName)

General Description: Creates a JavaScript object given a type name.

DispatchBCNotifications(returnPropSet)

General Description: Routes the notifications returned by the RPC to theSWE server to the

appropriate BusComp instances.

EnumBusObjs(first)

General Description: Iterates through the business objects thatregistered with the application.

EnumServices(first)

General Description: Iterates through the services loaded by the client.

EnumViews(first)

General Description: Iterates through the views registered with theapplication.

GetBusObj(name)

General Description: Returns a business object by name.

GetBusObjZone(zone)

General Description: Returns the Web Engine (WE) “zone” associated witha business object.

GetCommandMgr( )

General Description: Returns the top-level command manager that handlesand dispatches UI commands for toolbars and menus.

GetEditCaption( )

General Description: Returns the caption for edit mode applets.

GetEditCtlType( )

General Description: Returns the control type for edit mode applets.

GetHtmlFrameMgr( )

General Description: Returns the object that manages frames fordownloading new content.

GetJSSInfo(busObjZone, appletName, url)

General Description: Uses the HTML frame manager to load the URLspecified.

GetLocalString(key)

General Description: Returns the translated string for the specifiedkey. These translated strings are typically stored in the message tableand downloaded to the client on startup.

GetLocale( )

General Description: Returns the locale object.

GetMainView( )

General Description: Returns the current view of the application.

GetPageURL( )

General Description: Returns the URL for the current top-level page.

GetProfileAttr(attrName)

General Description: Returns the value of the named profile attribute onthe server.

GetRowCounterTemplate(key)

General Description: Return the string format template for one of therow counter formats.

GetService(name)

General Description: Loads a specified service object locally and on theserver. If the specified service has already been loaded, just incrementthe reference count.

GetView(busObjZone)

General Description: Gets the view corresponding to a “zone” of abusiness object.

InvokeMethod(name, inputPropSet)

General Description: Invokes the named method on the application.

ProcessClosePopup(returnPropSet)

General Description: Closes the popup as posted.

ProcessConfirmDialog(errObj, returnPropSet)

General Description: Handles a confirmation dialog as posted.

ProcessError(object)

General Description: Brings up an error dialog for the error registeredon the given object.

ProcessNewPage(returnPropSet)

General Description: Invokes a new page generation as posted.

ProcessRPCErrors(errObj, returnPropSet)

General Description: Handles errors returned by a call to the Web Engineon the server.

ProcessRPCNotifications(errObj, returnPropSet)

General Description: Handles notifications returned in a call to the WebEngine.

ProcessRPCRetPropSetStr(errObj, returnPropSetStr)

General Description: Handles returned property set from a call to WebEngine.

ReleaseService(service)

General Description: Releases the service immediately regardless of thereference count.

RemoveBusObj(busObj)

General Description: Remove a business object from the list of activeones.

RemoveObjFromArray(obj, arrayObj)

General Description: Removes an object from an array of objects.

WEAppletCanInvoke(appletName, viewName, busObjZone, method)

General Description: Calls the Web Engine to determine whether a methodcan be invoked on an applet.

WEApplicationCanInvoke(method)

General Description: Calls the Web Engine to determine whether a methodcan be invoked on the application.

WEBusCompCanInvoke(busCompName, busObjZone, method)

General Description: Calls the Web Engine to determine whether a methodcan be invoked on a business component.

WECallApplet(appName, viewName, busObjZone, method, inputPropSet)

General Description: Calls the Web Engine to invoke a specified remoteprocedure call on an applet.

WECallApplication(method, inputPropSet)

General Description: Calls the Web Engine to invoke a specified remoteprocedure call on the application.

WECallBusComp(busCompName, busObjZone, method, inputPropSet)

General Description: Calls the Web Engine to invoke a specified remoteprocedure call on a business component.

WECallService(serviceName, method, inputPropSet)

General Description: Calls the Web Engine to invoke a specified remoteprocedure call on a service.

WELoadService(name)

General Description: Calls the Web Engine to load a new service.

WEServiceCanInvoke(serviceName, method)

General Description: Calls the Web Engine to determine whether a methodcan be invoked on a service.

SetEditCaption(editCaption)

General Description: Sets up the caption used for edit mode.

SetEditCtlType(editCtlType)

General Description: Sets up the control type used for edit mode.

SetHtmlFrameMgr(htmlFrameMgr)

General Description: Sets up the HTML frame manager instance.

SetMainView(view)

General Description: Defines the main view.

SetPageURL(page Url)

General Description: Sets up the base URL for the application.

SetProfileAttr(attrName, value)

General Description: Changes the named user profile attribute to thespecified value.

SetWSFrame(wsFrameName)

General Description: Defines a special frame for the HTML frame manager.

ShowPopup(url, height, width)

General Description: Raises a popup applet or control.

In one embodiment, each browser-side business component object cantypically support the following business component methods:

AddField(name, . . . )

General Description: Specifies the configuration information for thefields when initializing the business component.

AddPickList(fieldName, picklist)

General Description: Specifies the pick list configuration for fieldswhen initializing the business component.

AddRecord(record)

General Description: Specifies initial record data when initializing thebusiness component.

Add UserProp(propName, value)

General Description: Specifies the configured user properties for thebusiness component during its initialization.

AddFieldUserProp(fieldName, propName, value)

General Description: Specifies the configured user properties for afield during initialization of the business component.

CallServerBC(method, inputProps)

General Description: Sends a method to the business component on theserver.

CanDelete( )

General Description: Determines whether the user can delete the currentrecord from the current business component.

CanInsert(dynamic)

General Description: Determines whether a new record can be inserted inthe current business component.

CaninvokeMethod(method)

General Description: Determines whether the named method can be invokedon the current business component.

CanMergeRecords( )

General Description: Determines the user can merge records in thecurrent business component.

CanQuery( )

General Description: Determines whether the current business componentsupports queries.

CanUpdate(dynamic)

General Description: Determines whether the current record can beupdated.

CanUpdateField(fieldName)

General Description: Determines whether a specified field can beupdated.

Cleanup( )

General Description: Performs a clean up before objects are destroyed.

ClearUpdates( )

General Description: Removes pending updates to the current record thathave not been sent to the server.

CopyRecord(before)

General Description: Creates a new record and copies the values of thecurrent record into the new record.

DeleteRecord( )

General Description: Deletes the current record.

DisableNotify( )

General Description: Suspends notification messages.

EnableNotify( )

General Description: Resumes sending of notification messages.

End( )

General Description: Moves the current record to the last record.

EnumPields(first)

General Description: Iterates through the fields defined on the businesscomponent.

EnumUserProps(start)

General Description: Iterates through the user properties defined on thebusiness component.

EnumFieldUserProps(start, fieldName)

General Description: Iterates through the user properties defined on thenamed field.

GetActiveFieldArray( )

General Description: Returns an array of names of currently activefields.

GetActiveRow( )

General Description: Returns the index into the working set of thecurrent row.

GetBusObj( )

Description: Return the business object that owns the current businesscomponent.

GetFieldDef(fieldName)

General Description: Returns the field object for the named field.

GetFieldIndex(fieldName)

General Description: Returns the index into the field array and recordarrays for the given field.

GetIdValue( )

General Description: Returns the row ID value for the current record.

GetFieldTotal(fieldName)

General Description: Returns the total for the named field.

GetFieldValue(fieldName)

General Description: Returns the value for the named field from thecurrent row.

GetFormattedValue(fieldName, format)

General Description: Returns the value for the named field from thecurrent row, formatted for the current locale settings and according tothe field type.

GetLocale( )

General Description: Returns the locale object for the system.

GetName( )

General Description: Returns the name of the business component.

GetNotifyObj(ntfyId)

General Description: Returns the notification object for the given ID.

GetNumRows( )

General Description: Returns the count of the number of rows seen by thecurrent business component.

GetParentBC( )

General Description: Returns the parent business component of thecurrent business component, if available.

GetPickList(fieldName)

General Description: Returns the pick list object for the named field.

GetRowNum( )

General Description: Returns the row number.

GetSearchSpec( )

General Description: Returns the search specification effective for thecurrent query.

GetFieldSearchSpec(fieldName)

General Description: Returns the search specification effective for thespecified field.

GetSortSpec( )

General Description: Returns the sort specification effective for thecurrent query.

GetUserProp(propname)

General Description: Returns the value of the named user property on thecurrent business component.

GetFieldUserProp(fieldName, propName)

General Description: Returns the value of the named user property on thespecified field.

HandleServerNotification(propSet)

General Description: Processes notification messages from the server forthe current business component. This method collects additionalinformation passed back from the server to update its internal state. Italso propagates the notification messages as appropriate.HasPickList(fieldName)General Description: Determines whether the given field has a definedpick list.HasFieldTotals( )General Description: Determines whether the business component cancalculates=totals for any fields.Home( )General Description: Sets the current row to the first row in the query.Initialize( )General Description: Sets up the state of the business component afterit is fully loaded and before its first use.InvokeMethod(name, inputPropSet)General Description: Calls the named method on the current businesscomponent.IsCurWSRecActive(ntfyId)General Description: Determines whether the current record of thisnotification object is the current record in the working set of thebusiness component.IsCurWSRecSelected(ntfyId)General Description: Determines whether the current record in thisnotification object has been selected in the business component.IsNumRowsKnown( )General Description: Determines whether the total number of records fromthe query is known.NextRecord( )General Description: Moves the current record in the business componentto the next record in the query.NextSet( )General Description: Scrolls the working set down.NewActiveRow(index)General Description: Updates the internal state when the current rowchanges.NewFieldData(fieldName, value)General Description: Updates the internal state when a field value ischanged on the server.NewRecord(before)General Description. Creates a new record in the business component withdefault field values.PositionById(id)General Description: Locates the record in the current query with thespecified ROW-ID and make it the current record.PriorRecord( )General Description: Moves the current record back one row in thecurrent query.PriorSet( )General Description: Scrolls the working set up.RedoRecord( )General Description: Re-applies changes previously removed.RegNotifyObj(notify)General Description: Registers a notification object with the businesscomponent.SetActiveRow(row)General Description: Sets the current row in the business component tothe specified index into the working set.SetBusObj(busObj)General Description: Sets the business object that owns the currentbusiness component.SetFieldValue(fieldName, value)General Description: Changes the value of the specified field in thecurrent record to the given value.SetFormattedValue(fieldName, value, format)General Description: Sets the value of the specified field in thecurrent record to the given value.SetName(name)General Description: Sets the name of the business component.SetParentBC(busComp)General Description: Sets the parent business component for a child.SetSearchSpec(spec)General Description: Sets the search specification effective for theinitial query.SetFieldSearchSpec(fieldName, spec)General Description: Sets the search specification effective for thespecified field.SetSortSpec(spec)General Description: Sets the sort specification in effect for theinitial query.SetTotaIsRecord(record)General Description: Sets the record that contains the total values forthe current query.Set WorkSetSize(ntfyId, size)General Description: Sets the number of records displayed in the workingset for a specified notification object.toString( )General Description: Returns a string that includes the name of thebusiness component.UndoRecord( )General Description: Undoes all changes since the last WriteRecord( )was invoked.UnRegNotifyObj(ntfyId)General Description: Removes registration of the notification objectspecified by the ID.UpdateRecord( )General Description: Puts the current record into a mode where aSetField Value( ) may be called.WriteRecord( )General Description: Sends any pending changes to the server and writesthem out to the database.WSEnd(ntfyId)General Description: Moves the current record for the specifiednotification object to the end of the query.WSGetFieldValue(ntfyId, fieldName)General Description: Returns the field value from current record of thespecified notification object.WSGetFormattedValue(ntfyId, fieldName, format)General Description: Returns the field value from current record for thecurrent notification object.WSGetBegRow(ntfyId)General Description: Returns the row number that corresponds to thefirst record in the working set of the specified notification object.WSGetCurrRow(ntfyId)General Description: Returns the index of the current record within thespecified notification object.WSHome(ntfyId)General Description: Moves the current record for the specifiednotification object to the beginning of the query.WSNextRecord(ntfyId)General Description: Moves the current record to the next record for thespecified notification object.WSSelectRow(ntfyId, row)General Description: Moves the current record for the specifiednotification object to index specified within this working set.WSSelectRowByld(ntfyId, id)General Description: Finds the row within this notification object byrow ID and callWSSelectRow( ).WSSetCurrRow(ntfyId, currrow)General Description: Moves the current record for the notificationobject record in the query identified by the row ID.

In one embodiment, each browser-side service object can typicallysupport the following service methods:

AddRef( )

General Description: Adds a reference to a service so that it will notbe automatically released.

CanInvokeMethod(name)

General Description: Determines whether the named method can be invokedon the current service?

FindApplet(name)

General Description: Finds the named applet with the main view.

GetApplication( )

General Description: Returns a pointer to the global application object.

GetBusComp( )

General Description: Return the business associated with the currentservice.

GetName( )

General Description: Return the name of the current service.

InvokeMethodAsString(name, argString)

General Description: This method is generally a convenience interface toInvokeMethod( ) whenthestring is already a formatted property set. CallsInvokeMethod( ) for implementation.

Invokemethod(name, inputPropSet)

General Description: Invokes the method on the current service.

Release( )

General Description: Removes the reference created by AddRef( ) allowthe service to be released.

SetApplication(app)

General Description: Sets the application object pointer on the service.

SetBusComp(busComp)

General Description: Sets the business component with the currentservice.

SetName(name)

General Description: Set the name of the server during initialization.Called only by SWE.

StringToPropSet(string)

General Description: Converts the argument string into a property set

In one embodiment, each browser-side applet can typically support thefollowing applet methods:

AddConditional(spanID, . . . )

AddDescription: Sets up the conditional to be implemented by the applet.

AddControl(name, . . . )

General Description: Sets up the controls on the applet.

AddMenu(menu)

General Description: Sets up the menu associated with the applet.

Add UserProp(propName, value)

General Description: Sets up the user properties for the applet.

AddControlUserProp(controlName, propName, value)

General Description: Sets up the user properties for a control.

ButtonMethod(name, inputPropSet)

General Description: This method is generally an interface toInvokeMethod( ) that first makes sure the applet is the active applet.

CallServerApplet(method, inputProps)

General Description: Forwards messages to the WE frame that correspondsto the current applet.

CanInvokeMethod(name)

General Description: Determines whether the given method can be invokedon the current applet.

DeletePopup( )

General Description: Closes a popup that is active from the currentapplet.

Close( )

General Description: Removes the current applet from the view. For apopup applet, restores the state in the parent applet.

Cleanup( )

General Description: Cleans up any state before an object is destroyed.

EnumUserProps(start)

General Description: Iterates through the user properties defined on thecurrent applet.

EnumControlUserProps(start, controlName)

General Description: Iterates through the user properties on the namedcontrol.

GetBusComp( )

General Description: Returns the business component on which the currentapplet is based.

GetControl(controlName)

General Description: Returns the control data structure for the namedcontrol.

GetFieldControl(fieldName)

General Description: Returns the control object that sits on top of thenamed field.

GetFieldSorting(fieldName)

General Description: Returns the sort state for the named field.

GetId( )

General Description: Returns the ID associated with the current applet.

GetInputValue(input)

General Description: Returns the value contained in the, given INPUT(control) element.

GetInputValueByName(name)

General Description: Returns the value from the input for the namedcontrol.

GetName( )

General Description: Returns the applet name.

GetNotifyObj( )

General Description: Returns the notification object registered by theapplet during initialization.

GetTitle( )

General Description: Returns the title of the applet.

GetVariable( )

General Description: Returns the HTML name of the variable that pointsto the current applet.

GetUserProp(propName)

General Description: Returns the value of the named user property.

GetControl UserProp(controlName, propName)

General Description: Returns the value of the named user property forthe given control.

GetView( )

General Description: Returns the parent view for the current applet.

GetPopupMethod( )

General Description: Returns the internal state of the popup applet.

GetPopupControl( )

General Description: Returns the control of the popup applet. Called byJavaScript framework.

GetPopupApplet( )

General Description: Returns the internal state of the popup applet.

GetPopupBookmark( )

General Description: Returns the internal state of the popup applet.

GetParentApplet( )

General Description: Returns the parent applet of a popup applet.

Initialize( )

General Description: Sets up the state on the applet after it has beencreated and before it is used.

InvokeMethod(name, inputPropSet)

General Description: Invokes the specialized method on this applet. Thisis the primary way that specialize applets register new methods.

IsActiveApplet( )

General Description: Determines whether the current applet is the oneactive within the view.

LeaveField(field)

General Description: This method is typically called when focus leavesan input element that corresponds to a control.

Populate( )

General Description: Sets up all UI elements on the applet with statefrom the business component.

ProcessError(object)

General Description: Brings up an error dialog for the error registeredon the given object.

SetAppletActive(isActive, newActiveApplet)

General Description: Sets the specified applet active or inactive. Ifthe first argument is true, the specified applet is being made active.

SetBusComp(busComp)

General Description: Set up the business component on which the currentapplet is based.

SetDocument(doc)

General Description: Sets up the HTUL document object for the currentapplet.

SetHighlightClasses(elementID, activeClass, inactiveClass)

General Description: Sets up the state for displaying the active applethighlight.

SetId(id)

General Description: Sets the ID for the current applet to distinguishit from other applets in the view.

SetInputValue(input, value)

General Description: Sets the current value of the input element currentvalue to a specified value.

SetName(name)

General Description: Sets the name of the applet.

SetNotifyObj(notifyObj)

General Description: Sets the given notification object as the activeone for this applet.

SetTitle(title)

General Description: Sets the title of the applet.

SetPopupMethod(popupMethod)

General Description: Sets the state of the popup applet.

SetPopupControl(popupControl)

General Description: Sets the state of the popup applet.

SetPopupApplet(popupApplet)

General Description: Sets the state of the popup applet.

SetPopupBookmark(popupbookmark)

General Description: Sets the state of the popup applet.

SetParentApplet(parentApplet)

General Description: Set the parent applet of a popup applet.

SetVariable(variable)

General Description: Sets the HTML variable that refers to the appletobject.

SetView(view)

General Description: Sets the parent view for the current applet.

toString( )

General Description: Returns a string that includes the applet name.

TryCondition(service, method, args)

General Description: Determines whether the given condition returnstrue. TryCondition( ) invokes the service method and returns the state.

UpdateConditionals( )

General Description: Re-evaluates conditionals now that some significantstate has changed.

UpdateRowCounter( )

General Description: Re-generates the row counter string and updates thedisplayed row counter.

Command Manager

In one embodiment, various user interface items or controls such astoolbars, menus, keyboard controls (also called keyboard shortcuts orkeyboard accelerators herein), etc. are used to provide the means forthe user to initiate various actions or commands. In one embodiment,toolbars may be designed and configured to appear in their own framenear the top of the application in the browser window, and theapplication menus (e.g., File, View and Help, etc.) may be designed andconfigured to appear beneath the primary tab (e.g., 1st levelnavigation) bar. In one embodiment, the applet-level menus can beinvoked from the applet menu button, in the control banner at the top ofan applet. FIGS. 16, 17, and 18 illustrate examples of toolbars,application-level menus, and applet-level menus, respectively. In oneembodiment, each user interface item or object in a toolbar,application-level menu, applet-level menu, or a particular keyboardshortcut or keyboard accelerator (e.g., CRTL+N) can be configure to beassociated or mapped to a particular command to be executed in responseto the user's selection or activation of the respective user interfaceitem (e.g., clicking on a menu item, pressing a keyboard combinationsuch as CTRL+N, etc.). In one embodiment, each command can be definedand configured to invoke one or more particular methods to perform oneor more particular functions or actions requested by the user. In oneembodiment, a data structure referred to herein as a command object canbe defined and configured to represent a particular command theexecution of which may result in the invocation of one or moreparticular methods associated with the respective command object.Command objects are described in more details below.

In one embodiment, a selection or activation of a toolbar icon or menuitem (e.g., user's clicking on a toolbar icon or menu item, etc.) isnormally translated into a call to an invoke method, which may reside ina service on the browser or server, or in classes in the browserapplication or server infrastructure (e.g., applet or business componentclasses, SWE frame manager, or model, etc.). In one embodiment, a userinterface item such as a toolbar icon, a menu item, or a keyboardshortcut may be configured to target a method name, a method handler(from which it may be automatically re-targeted if not found), andoptionally a service.

In one embodiment, application-level items (which may include bothtoolbar icons, application-level menus, and keyboard shortcuts, etc.)can be implemented through the use of command object definitions inTools, which are then mapped to Toolbar Item or Menu Item objectdefinitions. In one embodiment, applet-level menus do not utilizecommand object definitions, but the set of properties used for targetingand invoking the corresponding method are similar to those found in thecommand object type.

In one embodiment, in the web engine templates, the toolbar tag can beused to specify a named toolbar (where the name corresponds to the Nameproperty in the Toolbar object definition in the repository), and thetoolbaritem tag between the toolbar start and end tags recursivelyretrieves all of the toolbar items for that toolbar from the repository.

In one embodiment, a design-time menu activation/suppression feature isprovided for applet-level menus. This feature provides the capability tomake a menu item available globally for applets of a given class and itssubclasses, and then suppress it in particular applets where it is notdesired. In one embodiment, the design-time menu activation/suppressionfeature can be implemented using the Class Method Menu Item object type,which can be used to implement the menu item in the applet-level menu ofall applets of the specified applet class, except where suppressed asdefined by the Suppress Menu Item property. Applet method menu item,class method menu item, and the suppression of menu item are describedin greater details below.

FIG. 19 shows a flow diagram of one embodiment of a process 1900 forcreating various objects that are used for the configuration andexecution of the various commands. As shown in FIG. 19, the process mayinclude the following actions:

Creating one or more command objects (at block 1910)

Creating one or more toolbar objects (at block 1920)

Creating one or more toolbar item objects (at block 1930)

Creating one or more application-level menu objects (at block 1940)

Creating one or more application-level menu item objects (at block 1950)

Creating one or more applet method menu item objects (at block 1960)

Creating one or more class method menu item objects (at block 1970)

Creating one or more keyboard accelerator objects, also called keyboardshortcuts, shortcut keys herein (at block 1980)

FIG. 20 shows a flow diagram of one embodiment of a process 2000 forcreating a command object in accordance with the teachings of thepresent invention. Creating a command object can generally includedefining a command object definition (at block 2010) and specifying theproperties associated with the defined command object (at block 2020).

FIG. 21 illustrates one embodiment of the properties of a command objectaccording to the teachings of the present invention. In one embodiment,a command object may include the following properties: Target 2110,Business Service 2120, Method 2130, Method Argument 2140, Show Popup2150, HTML Popup Dimensions 2160, Bitmap/HTML Bitmap 2170, and TooltipText 2180. Command objects and their properties are described in moredetails below.

In one embodiment, a command object definition is created and configuredto specify which invoke method is called when a toolbar icon orapplication-level menu item associated with the command is executed.Furthermore, a command object definition may be used to specify whichbitmap appears on the toolbar icon for toolbar items. In one embodiment,command object definitions are referenced by Toolbar Item or Menu Itemobject definitions. As illustrated in FIG. 21, a Command objectdefinition generally has the following properties:

Target property 2110 generally specifies which entity handles the invokemethod the command calls. In one embodiment, available options are thefollowing:

-   -   Browser: in this case, the method handler can be a JavaScript        service on the browser, or the JavaScript application, depending        on whether or not a service is specified in the Business Service        property.    -   Server: in this case, the method handler can be an object        manager service on the server, or the object manager        infrastructure (e.g., the SWE UDF loader, or secondarily the        model), depending on whether or not a service is specified in        the Business Service property.

Business Service property 2120 generally specifies the service (eitheron the browser or server, depending on the Target property) that handlesthe invoke method. In one embodiment, if the property is left blank, thebrowser or server infrastructure is targeted rather than a specificservice. In one embodiment, if a service is specified, it handlesCanInvokeMethod and InvokeMethod for the method specified in the Methodproperty.

Method property 2130 generally is used to specify the name of the methodto invoke when a user interface item (e.g., the menu item, toolbar icon,etc.) is selected. In one embodiment, this property is a requiredproperty.

Method Argument property 2140 generally is used to provide a mechanismto pass an argument to the invoke method specified in the Methodproperty. For example, a command item that opens a new window andnavigates to a URL in that window can specify the GotoURL method inMethod property and the URL to navigate to in the Method Argumentproperty.

Show Popup property 2150. In one embodiment, this property is set toTRUE to specify that a new browser window is opened before invoking themethod. It is set to FALSE to specify that the method is invoked in thecurrent browser window.

HTML Popup Dimensions property 2160. In one embodiment, this property isused to specify the dimensions, in pixels, of the popup window, whenShow Popup property 2150 is TRUE. An example is 640×480 (specified withthe “x” and without blank spaces).

Bitmap/HTML Bitmap property 2170.

Tooltip Text property 2180. In one embodiment, this property is used tospecify the tooltip text which appears when the cursor lingers on atoolbar icon. In one embodiment, for built-in methods, the tooltip textshould be left blank which indicates that the method will dynamicallysupply the text, and language localization takes place as a part of thisprocess. For developer-defined methods, literal text can be entered forthis property. In one embodiment, when the literal text is entered forthis property, it turns off language localization for this tooltip text.

FIG. 22 shows a flow diagram of one embodiment of a process 2200 forcreating a toolbar object in accordance with the teachings of thepresent invention. Creating a toolbar object can generally includedefining a toolbar object (at block 2210) and specifying the propertiesassociated with the defined toolbar object (at block 2220).

FIG. 23 illustrates one embodiment of the properties of a Toolbar objectaccording to the teachings of the present invention. In one embodiment,a Toolbar object may include the following properties: Class 2310, Name2320, Display Name 2330, and Popup Indicator Bitmap 2340. Toolbarobjects and their properties are described in more details below.

In one embodiment, for each toolbar in the application, a Toolbar objectdefinition can be created in the Object List Editor. This provides anamed toolbar that the user can activate or deactivate in variousapplications, and to which toolbar icons (e.g., Toolbar Item objectdefinitions) can be associated or removed. Toolbar functionality forapplications can be implemented using HTML toolbars. In one embodiment,in an HTML toolbar, the buttons are static images, which may be dimmedto indicate unavailability, but otherwise are not manipulated by programlogic on the browser. In contrast, CTI (computer telephony integration)applications may require toolbar icons that can be altered in responseto events, such as blinking a particular toolbar icon when a call isincoming. In one embodiment, this may require the use of Java toolbars.In one embodiment, to specify that a toolbar is of the Java type, aclass name is entered in the Class property. As shown in FIG. 23, atoolbar object may include the following properties:

Class property 2310. In one embodiment, this property is left blank foran HTML toolbar and specified for a Java toolbar (e.g., the name of theJava class that implements the toolbar is entered).

Name property 2320. In one embodiment, this property is referenced byother object definitions, and by the toolbar tag in the “name=” clause.Display Name property 2330. In one embodiment, this property is used forthe History button and to show or hide toolbars by name.

Popup Indicator Bitmap property 2340. In one embodiment, this propertyis used to specify a sideways toolbar popup.

FIG. 24 shows a flow diagram of one embodiment of a process 2400 forcreating a toolbar item object in accordance with the teachings of thepresent invention. Creating a toolbar item object can generally includedefining a toolbar item object (at block 2410) and specifying theproperties associated with the defined toolbar item object (at block2420).

FIG. 25 illustrates one embodiment of the properties of a toolbar itemobject according to the teachings of the present invention. In oneembodiment, a toolbar item object may include the following properties:Command property 2510, HTML Type property 2520, Name property 2530,Sequence property 2540, and Position property 2550. Toolbar item objectsand their properties are described in more details below.

In one embodiment, a Toolbar Item object is defined and configured toassociate a Command object definition (which is identified by name as aproperty in the Command property of the toolbar item object) with aToolbar object definition (which is the parent of the Toolbar Itemobject). In one embodiment, this association places a toolbar icon whosebitmap image, invoke method and target are specified in the Commandobject definition, on the specified toolbar in a given location (e.g., aposition relative to the other toolbar icons on that toolbar). In oneembodiment, as illustrated in FIG. 25, a toolbar item object may bedefined to include the following properties:

Command property 2510. In one embodiment, this property specifies thename of the Command object definition that is to provide the bitmap,method and target for the respective toolbar item. In one embodiment,one or more hyphens can be specified instead of the name of a Commandobject to tell the system to insert a separator there between icons.

HTML Type 2520. In one embodiment, this property is used to identify thetype of control to be displayed in the corresponding toolbar in thebrowser. In one embodiment, various options may include ComboBox,Button, Edit, Label, Hyperlink, MiniButton and Timer, etc.

Name property 2530. In one embodiment, this property specifies the nameof the Toolbar Item. In one embodiment, the name property needs to beunique within the scope of a toolbar.

Sequence property 2540. In one embodiment, this property specifies aninteger that orders the toolbar item in the parent toolbar from left toright. For example, a higher sequence number relative to other toolbaritems places this icon further to the right than the others.

Position property 2550. In one embodiment, this property is used forsideways toolbars. For example, a value of 0.1, 0.2, etc. can be used.

In one embodiment, a menu object can be defined and configured for eachapplication-level menu. In one embodiment, a menu object is considered aparent of corresponding menu item objects. A menu item object is used todefine an application main menu or menu item within the parent menuobject definition.

FIG. 26 shows a flow diagram of one embodiment of a process 2600 forcreating a menu item object in accordance with the teachings of thepresent invention. Creating a menu item object can generally includedefining a menu item object (at block 2610) and specifying theproperties for the defined menu item object (at block 2620).

FIG. 27 illustrates one embodiment of the properties of a menu itemobject according to the teachings of the present invention. In oneembodiment, a menu item object may include the following properties:Name property 2710, Command property 2720, Caption property 2730, andPosition property 2740. These properties are described in more detailsbelow:

Name property 2710. In one embodiment, this property is used to uniquelyidentify the menu or menu item.

Command property 2720. In one embodiment, this property specifies thename of the corresponding Command object definition that is used toprovide the method and target for the respective menu item.

Caption property 2730. In one embodiment, this property specifies thetext that is displayed in the menu or menu item.

Position property 2740. In one embodiment, this property specifies theposition of the menu or menu item in the menu tree. For example, thetop-level positions, for menus (rather than items within them) can besingle integers such as 1, 2, and 3 (or 10, 20 and 30). Position uvaluesfor menu items (e.g., 2nd level and below in the menu tree) can bespecified using a dot notation, where the value to the right of therightmost dot specifies the order of the item on its level, and thevalue or values to the left of that dot specify the parent menu or menuitem. For example, 3.1 can be defined as the first item in the submenuof the third item of the top-level menu. It should be noted that valueson a level are not required to be consecutive—for example, the values1110, 1115, 1120 and 1130 may be used to indicate four menu items on thesame level and their sequence determines their order of display in themenu.

In one embodiment, an applet method menu item object is used to define amenu item in the applet-level menu for the parent Applet objectdefinition. In one embodiment, unlike application-level menus, appletmenus are not based on Command objects. However, the set of propertiesused for targeting the method are similar to those found in the commandobject type. FIG. 28 shows a flow diagram of one embodiment of a process2800 for creating an applet method menu item object in accordance withthe teachings of the present invention. Creating an applet method menuitem object can generally include defining an applet method menu itemobject (at block 2810) and specifying the properties for the definedapplet method menu item object (at block 2820).

FIG. 29 illustrates the properties of an applet method menu item objectaccording to one embodiment of the present invention. In one embodiment,an applet method menu item object may include the following properties:Menu Text property 2910, Target property 2920, Method property 2930,Business Service property 2940, Suppress Menu Item property 2950, andPosition property 2960. These properties are described in more detailsbelow.

Menu Text property. In one embodiment, this property is used to specifythe text displayed in the menu item.

Target property. In one embodiment, this property is used to specifywhich entity handles the invoke method specified in the Method property.In one embodiment, the following options are available:

-   -   Browser. In this case, the method handler can be a JavaScript        service on the browser, or the JavaScript applet class (or        secondarily the JavaScript business component class) on the        browser, depending on whether or not a service is specified in        the Business Service property.    -   Server. In this case, the method handler can be an object        manager service on the server, or the applet and business        component and their superclasses, depending on whether or not a        service is specified in the Business Service property.

Method property. In one embodiment, this property is used to specify themethod to be invoked when the corresponding menu item is selected.

Business Service property. If specified, this property identifies theservice on which to invoke the specified method. If unspecified, thespecified method is invoked on the applet class on the browser or server(as specified in the Target property) with subsequent retargeting ifunhandled.

Suppress Menu Item property. In one embodiment, the default for thisproperty is set to FALSE. If this property is set to TRUE, it causes theclass-level menu item of the specified name to be removed from theapplet-level menu in the applet where this property is specified.Position property. In one embodiment, this property is used to specifythe sequence of the menu item in the single-level list of menu items.

FIG. 30 shows a flow diagram of one embodiment of a process 3000 forcreating a class method menu object in accordance with one embodiment ofthe present invention. In one embodiment, a class method menu item canbe defined and configured to add or suppress a menu item on applet-levelmenus for all applets of the specified applet class and its subclasses.Creating a class method menu item object can generally include defininga class method menu item object (at block 3010) and specifying theproperties for the defined class method menu item object (at block3020).

FIG. 31 illustrates properties of a class method menu item according toone embodiment of the present invention. In one embodiment, a classmethod menu item object may include the following properties: Targetproperty 3110, Menu Text property 3120, Method property 3130, BusinessService property 3140, Suppress Menu Item property 3150, and Positionproperty 3160. These properties are described in more details below.

Target property. In one embodiment, this property is used to specifywhich entity handles the invoke method specified in the Method property.In one embodiment, the following options are available:

-   -   Browser. In this case, the method handler can be a JavaScript        service on the browser, or the JavaScript applet class (or        secondarily the JavaScript business component class) on the        browser, depending on whether or not a service is specified in        the Business Service property.    -   Server. In this case, the method handler can be an object        manager service on the server, or the applet and business        component and their superclasses, depending on whether or not a        service is specified in the Business Service property.

Menu Text property. In one embodiment, this property is used to specifythe text displayed in the menu item.

Method property. In one embodiment, this property is used to specify themethod to be invoked when the corresponding menu item is selected.

Business Service property. If specified, this property identifies theservice on which to invoke the specified method. If unspecified, thespecified method is invoked on the applet class on the browser or server(as specified in the Target property) with subsequent retargeting ifunhandled.

Suppress Menu Item property. In one embodiment, the default for thisproperty is set to FALSE. If this property is set to TRUE, it causes theapplet-level menu items of the specified name to be removed from theapplet-level menu in all applets derived from this class and itssubclasses.

Position property. In one embodiment, this property is used to specifythe sequence of the menu item in the single-level list of menu items.

FIG. 32 is a diagram illustrating the relationship between toolbarobjects, toolbar item objects, and command objects in accordance withone embodiment of the present invention. As shown in FIG. 32, a toolbarobject as described herein can generally be associated to one or moretoolbar item objects. In one embodiment, each toolbar item object can beassociated or mapped to a corresponding command object (e.g., by usingthe command property of the respective toolbar item object). In otherwords, a command object can be referenced by a toolbar item object usingthe command property of the toolbar item object to specify the name ofthe command object as described above

FIG. 33 is a diagram illustrating the relationship between a menuobject, menu item objects, and command objects. As shown in FIG. 33, amenu object as described herein can generally be associated to one ormore menu item objects. In one embodiment, each menu item object can beassociated or mapped to a corresponding command object (e.g., by usingthe command property of the respective menu item object). In otherwords, a command object can be referenced by a menu item object usingthe command property of the menu item object to specify the name of thecommand object as described above.

FIG. 34 is a diagram illustrating the relationship between an appletlevel menu object, applet method menu item objects, and class methodmenu item objects. As shown in FIG. 34, an applet level menu cangenerally be associated to one or more applet method menu item objects.In one embodiment, each applet method menu item object can be associatedor mapped to a class method menu item object (e.g., by using theSuppression Menu Item property as described herein).

Menu Item and Toolbar Item Activation and Suppression

In one embodiment of the present invention, menu items (e.g., bothapplication-level and applet-level) and toolbar items can be enabled ordisabled at runtime, by using the CanInvokeMethod mechanism. In oneembodiment, CanInvokeMethod (for the method specified in the Command,Applet Method Menu Item or Class Method Menu Item object, etc.) will becalled automatically for each item prior to displaying the menu ortoolbar. If CanInvokeMethod returns FALSE, the toolbar item or menu itemdisabled (e.g., is not displayed). The CanInvokeMethod logic generallyis retargeted from the browser application to the applet class hierarchyon the server, and from there to the business component class hierarchy.The targeting sequence is described in more details below.

As described herein, in one embodiment, suppression and activation ofindividual applet-level menu items at design time is supported by usingthe Suppress Menu Item property in the Class Method Menu Item and AppletMethod Menu Item object types. In one embodiment, this mechanism orfeature is applicable to applet-level menus, not application-level menusor toolbars, in which the item is added or removed explicitly.Design-time menu activation/suppression for applet-level menus providesthe mechanism to make a menu item available globally for applets of agiven class and its subclasses, and then suppress it in particularapplets where it is not desired. For example, various applet-level menuitems appear in virtually all applets (such as Copy, Edit and Delete,etc.), others appear in virtually all list applets (such as ColumnsDisplayed), and so on, but there can be some cases in which a “standard”menu item for the applet's class needs to be suppressed for a specificapplet.

In one embodiment, to add applet-class-level menu items, a Class MethodMenu Item is added for a standard menu item for a given applet class. Inone embodiment, this menu item would not need to be re-included asApplet Method Menu Item object definitions in applets in which the menuitem is to appear. In one embodiment, Applet Method Menu Item objectdefinitions are created in two circumstances: to add a menu item (notalready provided by the applet's class) to the applet, or to suppressdisplay of an applet-class-level item that the applet would normallyinherit. In the latter case, an Applet Method Menu Item objectdefinition is created with the same name as the applet-class-level menuitem which is to be suppressed, and a value of FALSE is entered for theSuppress Menu Item property.

Invoke Method Targeting

According to one embodiment of the present invention as describedherein, the Method, Business Service and Target properties are includedin the Command object type (for use in toolbars and application-levelmenus) and in the Class Method Menu Item and Applet Method Menu Itemobject types (for use in applet-level menus). In one embodiment, twosettings or options are available for the Target property, with thefollowing behavior:

Browser target: the method handler for this target can be the JavaScriptapplication, a JavaScript applet, or a JavaScript service, on thebrowser side. In one embodiment, regardless of which entity is themethod handler, a method name needs to be specified in the Methodproperty. In one embodiment, a service is targeted if a service name isspecified in the Service property. If a service is not specified in theService property, method handling differs based on whether the callingentity is application-level or applet-level, as follows:

-   -   Application-level: targets to the specified method in the        JavaScript application. There is no retarget in this case.    -   Applet-level: targets to the specified method in the JavaScript        applet. If not handled, retargets to the specified method in the        corresponding JavaScript business component. There is no        inheritance or additional retargeting in this case.

Server target: this target is for invoking a method on a server (e.g., amethod in a C++ class on the server), either on a service or on theinfrastructure. If a Service property value is not specified, the invokemethod is targeted to the infrastructure. It will target theinfrastructure differently depending on whether the menu or toolbar iconinvoking the method is applet-level (menu only) or application-level(menu or toolbar), as follows:

-   -   Application-level: the method handler is initially the SWE UDF        loader on the server side, and secondarily the model.    -   Applet-level: the method handler is initially the applet class        to which the applet belongs, and is retargeted successively up        through the applet class hierarchy to CSSSWEFrame. If still        unhandled, handling is retargeted to the business component        class of the applet's business component, and successively        upwards through the business component class hierarchy to        CSSBusComp.

If a service is specified in the Service property, the method handler isthe specified service. This targeting is also dependent on whether thecalling menu item or toolbar icon is applet-level or application-level,as follows:

-   -   Application-level: the method handler is the specified OM        service. There is no retarget in this case.    -   Applet-level: the method handler performs a SetBC call to set to        the business component of the applet, and then calls the        specified OM service. There is no retarget in this case.

The following matrix or table illustrates the results of the possiblesettings of the Target and Business Service properties at the applet andapplication levels, in accordance with one embodiment of the presentinvention:

Menu/ Toolbar Level Target Service Result Appli- Server specified Themethod handler is the specified cation- OM service. It does notretarget. level unspecified The method handler is initially the SWE UDFloader on the server side, and secondarily the model. Browser specifiedTargets to the method in the specified browser-side service. Does notretarget. unspecified Targets to the specified method in the JavaScriptapplication. Does not retarget. Applet- Server specified The methodhandler performs a level SetBC call to set the business component of theservice to the business component of the applet, and then calls thespecified OM service. It does not retarget. unspecified The methodhandler is initially the applet class to which the applet belongs, andis retargeted successively up through the applet class hierarchy toCSSSWEFrame. If still unhandled, handling is retargeted to the businesscomponent class of the applet's business component, and successivelyupwards through the business component class hierarchy to CSSBusComp.Browser specified Targets to the method in the specified browser-sideservice. Does not retarget. unspecified Targets to the specified methodin the JavaScript applet. If not handled, retargets to the specifiedmethod in the corresponding JavaScript business component. Noinheritance or additional retargeting.

FIG. 35 illustrates a block diagram of one embodiment of a systemconfiguration 3500 in which the teachings of the present invention maybe implemented. The system configuration 3500 includes a client-sidecommand manager that is configured to manage the processing of variouscommands that are initiated by a user of the system, based upon theinformation that are specified in the properties associated with therespective commands. As shown in FIG. 35, the system configurationfurther includes, on the server side, a command manager service and aserver-side command manager. In one embodiment, the command managerservice is configured to receive from the client-side command managerthose commands that are targeted for the server. In one embodiment, thecommand manager service acts as a focal point for receiving andforwarding the received commands to the server-side command manager. Inone embodiment, the server-side command manager is configured to processthose commands that are targeted to the server. In one embodiment, theserver-side command manager is configured to determine, based upon theproperties associated with the respective commands, which entity tohandle the method specified in the respective command. As describedabove, a command can be mapped to a user interface item (also called acommand item, control or control item herein) such as a toolbar item, amenu item, a keyboard accelerator item (also called keyboard shortcut orshortcut key), etc. In general, the user's selection or initiation of acommand (e.g., by clicking on a toolbar icon, menu item or by pressing akeyboard combination, etc.) is translated into a call to an invokemethod which may reside in a service on the browser or the server, or inthe corresponding classes in the browser application or serverinfrastructure (e.g., applet or business component classes, etc.). Asdescribed above, a toolbar icon, menu item, or a keyboard acceleratoritem is configured to target a method, a method handler (from which itmay be automatically retargeted if not found), and optionally a service.

FIG. 36 shows a flow diagram of a process 3600 in accordance with oneembodiment of the present invention. At block 3610, it is determinedwhether a command item associated with a menu, toolbar, or keyboard isenabled (e.g., whether the method associated with the command item canbe invoked). As described above, menu items (both application-level andapplet-level) and toolbar items can be enabled or disabled at runtime byusing the CanInvokeMethod mechanism as described above. In oneembodiment, CanInvokeMethod is called for each item prior to displayingthe menu or toolbar. In one embodiment, the CanInvokeMethod returns avalue (e.g., FALSE) to indicate that the command item is not enabled(e.g., the method cannot be invoked) and another value (e.g., TRUE) toindicate that the command item is enabled (e.g., the method can beinvoked). In one embodiment, if the respective command item is notenabled (e.g., CaninvokeMethod returns FALSE value), then the respectiveitem is not accessible by the user (e.g., the menu or toolbar item isnot displayed, or dimmed out, etc.). At block 3620, if the respectiveitem is enabled (e.g., CanInvokeMethod returns TRUE value), thenindicate to the user that the respective item can be selected (e.g.,displaying the menu item or toolbar item to the user). At block 3630, inresponse to the user's selection of the respective command item (e.g.,user clicking on the menu or toolbar item or pressing the shortcut key,etc.), the command associated with the respective item is routed to anappropriate destination (e.g., the method handler) for processing, basedupon the target and service properties and whether the calling entity isapplet-level or application-level, as described above. At block 3640,the command associated with the selected command item is processed.

FIG. 37 is a flow diagram of a process 3700 according to one embodimentof the present invention. At block 3710, a command object is defined asdescribed above. At block 3720, a user interface item object (e.g., atoolbar item object, a menu item object, a keyboard accelerator itemobject, etc.) is defined as described above. At block 3730, a userinterface item object is associated to a corresponding command object.In one embodiment, at run time, the server prepares commands based onthe command object definitions. In one embodiment, the various commandsare then attached to their corresponding command items (e.g., menuitems, toolbar items, keyboard accelerator items, etc.). In oneembodiment, a command is prepared as a string containing the propertiesthat are necessary for the processing of the command when selected orinitiated by the user (e.g., target property, method property, businessservice property, etc.). At block 3740, it is determined whether theuser-interface item (e.g., menu item, toolbar item, etc.) is enabled, asdescribed above. At block 3750, if the item is enabled, indicate to theuser that it can be selected. At block 3760, in response to the user'sselection of the command item, determine an appropriate entity (e.g.,method handler) to process the selected command based on various factorsas described above including the target property and the businessservice property associated with the selected command and whether thecalling entity is applet-level or application-level. At block 3770, theselected command is routed to the determined target (the methodhandler). At block 3780, the selected command is processed (e.g., invokethe specified method associated with the selected command).

Immediate Post-When-Change

FIG. 38 shows a block diagram illustrating the relationship betweenvarious objects according to one embodiment of the present invention. Asshown in FIG. 38, a business object can be defined and configured as alogical grouping or mapping of various business components (e.g., abusiness object typically groups one or more business components into alogical unit of information). As described herein and shown in FIG. 38,a business component can be defined and configured as a logical groupingor mapping of underlying tables (e.g., database tables). In other words,a business component typically provides a layer of wrapping overunderlying tables. Each underlying table (e.g., database table)typically contains a number of records or rows. Each record or row mayinclude a plurality of columns or fields.

FIG. 39 shows a block diagram of a logical structure of a businesscomponent in accordance with one embodiment of the present invention. Asshown in FIG. 39, a business component may include a set of propertiesthat pertain to the respective business component (e.g., NAME whichspecifies the logical name of the business component, TABLE NAME whichspecifies the actual name of the underlying table, etc.). A businesscomponent also includes a set of fields each of which may have a set ofassociated properties. For example, a field may include a NAME propertywhich identifies the name of the field, a COLUMN NAME which identifiesthe column of the underlying table to which the respective field ismapped, etc.

Typically, the value of a particular field may depend upon the value ofanother field. The dependency or inter-dependency between field valuesmay exist in various ways. For example, assuming that a user wishes toenter an address which typically includes various fields, the value thatthe user enters for a particular field (e.g., State field) may determinethe set of valid values that the user can enter in another field (e.g.,City field). As another example, a particular field may become disabledor read-only when the value in another field changes. Furthermore, theremay be cases where the type of user-interface control or format used toshow a particular field may change based on the value entered in anotherfield. For example, the user interface control for a particular fieldmay be configured to change from a text box in which a user can enterany value into a combo-box where the user has to choose from a list ofexisting values.

Conventionally, in a client server environment, the client waits for theuser to finish entering a set of changes, post the changes to the serverfor processing and then shows the user another page with the dependentinformation between field values. For example, in a conventionapplication or system, the client waits for the user to finish enteringall the address information such as STATE, CITY, etc. and then posts allthe changes to the server. The server will then send a new page to theclient for display to the user which may include the relevant dependentinformation between fields. This conventional method or conventional wayof handling and processing dependency or inter-dependency between fieldvalues is not effective because changes due to the inter-dependencybetween field values are not seen by the user immediately, thus makingthe user interface environment much less interactive. For example, afterthe user has changed the value of a particular field (upon which thevalue and/or layout of another field depends), the user will notrecognize or see the effect of the change until after all the changeshave been posted to the server and a new page is displayed.

To solve the problem described above, according to one aspect of thepresent invention, a method is provided in which a change in value of afield upon which the values, format, or functionality of other fieldsdepend will be immediately posted to the server for processing (alsoreferred to as the immediate post-when-change feature or immediatepost-when-change mechanism herein).

According to one embodiment of the present invention, the fields uponwhich the other field(s) depend are marked for immediatepost-when-change in the repository. This information is thereforeavailable as part of the meta-data. In one embodiment, the client sideframework uses this information to decide when to send changes to fieldvalues to the server for processing. The server will then respond usingthe notification mechanism described above to send back dependentchanges as a result of the changes processed by the server. For example,upon detecting that the value of a particular field has changed (thisparticular field is marked for immediate post-when-change), the clientwill immediately submit the value of this particular field and thevalues of other client-side fields that have changed to the server forprocessing. The server will then respond using the notificationmechanism to send back the dependent changes for the client to takeappropriate actions based on the dependent changes. For example, if thechange of value of a first field causes the value and/or format of asecond field to be changed, upon receiving the notifications from theserver, the client will change the value and/or the format of the secondfield accordingly. In one embodiment, the logic to perform the immediatepost-when-change process is implemented as part of the Javascript coderunning on the client side.

FIG. 40 shows some properties or attributes of a business componentfield in accordance with one embodiment of the present invention. Inaddition to the typical properties or attributes such as NAME, COLUMNNAME, etc., a business component field may also include a property orattribute that is used to mark the respective business component fieldfor immediate post-when-change processing as described above. Forexplanation and illustration purposes, this property can be referred toas the IMMEDIATE POST-WHEN-CHANGE property. In one embodiment, thisproperty can be set to one value (e.g., TRUE) to indicate that thecorresponding business component field is marked for immediatepost-when-change processing and set to another value (e.g., FALSE)otherwise. As described above, this information is used by the clientside framework to decide when to send changes to field values to theserver for processing.

FIG. 41 shows a flow diagram of one embodiment of a process according tothe teachings of the present invention. At block 4110, one or morefields upon which other field(s) depend are identified. At block 4120,the identified fields are marked for immediate post-when-changeprocessing. As described above, in one embodiment, the identified fieldsare marked in the repository (e.g., by setting the appropriate propertyof these fields to a specific value) and hence this information isavailable as part of the meta-data. At block 4130, during runtime, theclient detects whether the values of the marked fields are changed. Atblock 4140, if the values of the marked fields have changed, the clientsends their values and the values of other client-side fields that havechanged to the server for processing. At block 4150, the serverprocesses the changes and responds using the notification mechanism tosend back the dependent changes to the client.

Busy State Manager

One of the problems experienced in a traditional HTML or web-basedapplication is that once a client (e.g., the browser) sends a request toa server for processing, it will time out if the server does not respondwithin a certain period of time. This time out condition occurs in spiteof the fact that certain requests may take a long time to processdepending upon various factors such as the type of the request, theavailable resources on the server, and the number of requests beingprocessed or waiting to be processed by the server, etc. For example, aclient in a traditional web-based or HTML application may submit arequest that involves a very time-consuming query operation in a largedatabase. This request may not be finished before the time out conditionoccurs.

According to one embodiment of the present invention, a mechanism isprovided so that when a client submits a request to a server thatinvolves long-running or time-consuming operations on the server side,the server can inform the client accordingly using the notificationsmechanism described above. Based upon the information provided by theserver regarding the request, the client can take appropriate actions toinform a user of the status of the request (e.g., by displaying aprogress bar showing how much of the task has been completed thus far,etc.). In one embodiment, the communications regarding the status andprogress of the request can be managed as described in more detailsbelow.

FIG. 42 shows a block diagram of one embodiment of a systemconfiguration according to the teachings of the present invention. Asillustrated in FIG. 42, the client can include a component called abusy-sate manager that is configured to monitor and inform a user of thestatus and progress of a request submitted to the server, based uponinformation provided by the server (e.g., notifications provided by theserver regarding the status and progress of the request processing). Inone embodiment, the server can also include a busy-state manager on theserver side that is configured to inform the client of the status andprogress of the request received from the client. In one embodiment, thebusy-state manager on the server side is configured to determine, uponreceiving the request from the client, whether the request may involvelong-running server operations or may take a long time to finish, basedupon various factors. In one embodiment, these various factors mayinclude the type of the request, the priority of the request, theresources available for request processing, the number of pendingrequests which may include requests that are being processed andrequests that are waiting in a queue to be processed by the server, etc.

In one embodiment, upon determining that the request received from theclient may take a long time to process (e.g., the request involveslong-running server operations, etc.), the server will notify the clientaccordingly. In one embodiment, once the client is informed by theserver that the request may take a long time to process, the client caninform the user that the request processing has started and lock theuser interface during the time the request is being processed by theserver. In one embodiment, the server will continue to inform the clientof the progress of the request and the client can take appropriateactions to inform the user accordingly, until the request processing isfinished. For example, upon receiving the progress information from theserver via the notifications, the client can update a progress bar toshow the user how much of the task has been completed at that point intime. In one embodiment, the user interface will continue to be lockeduntil the request processing is completed.

FIG. 43 is a flow diagram of a process 4300 in accordance with oneembodiment of the present invention. At block 4310, the client sends arequest to a server. At block 4320, the server determines that therequest may take a long time to process (e.g., the request involveslong-running server operations, etc.). At block 4330, the servernotifies the client that the request may take a long time to finish. Inone embodiment, the server communicates this information to the clientusing the notification mechanism described above. At block 4340, theclient locks the user interface and informs the user that the requestprocessing has started and may take a long time to finish. At block4350, the server notifies the client of the progress the requestprocessing. At block 4360, the client informs the user of the progressof the request processing (e.g., using a progress bar), based on theinformation provided by the server. At block 4370, the client continuesto lock the user interface and inform the user of the progress of therequest based on the progress information provided by the server, untilthe request processing is completed.

III. Caching

As stated above, objects on the browser and objects managed by the OMcan be configured to reside and operate on one or multiple computingdevices. As shown above, FIG. 6A illustrates an exemplary configuration600 in which objects 502 on the browser and objects 504 managed by theOM reside and operate on multiple computing devices 602 and 604,including a client 602 and a server 604. FIG. 6B illustrates anexemplary configuration 650 in which objects 502 on the browser andobjects 504 managed by the OM reside and operate on one computing device652.

FIG. 44 is generally a partially block diagram of a frame orinfrastructure operating on a multiple-device configuration 4400 similarto the configuration 600 shown in FIG. 6A and described above in thetext accompanying FIG. 6A. FIG. 44 shows a browser 4402 running on theclient 4404. The browser 4402 communicates with the server 4406 usingthe RPC mechanism 4408 and the notification mechanism 4410, which havebeen described above in more details.

A view or JSSView object 4412 and a plurality of applets or JSSAppletobjects 4414 ₁, 4414 ₂, . . . , 4414 _(N), where N is a positive integerare shown to be running on the browser 4402. The JSSView object 4412generally represents a view. As stated above, a view is generally adisplay panel consisting of a particular arrangement of applets. Aspreviously discussed, an applet is generally a visual application unitthat appears on the screen as part of a view. Each applet or JSSAppletobject 4414 ₁, 4414 ₂, . . . , 4414 _(N) represents an applet that isassociated to the view represented by the view or JSSView object.

The client 4404 includes a cache 4416 to generally store views toimprove performance. At times, the user can navigate or switch to newviews causing the client 4404 to submit corresponding requests tonavigate to new views to the server 4406. As previously discussed, whenthe client 4404 submits a request to navigate to a view to the server4406, the server 4406 would send a response or notification containingthe view layout that is devoid of data. Accordingly, a round trip to theserver 4406 (including a request from the client 4404 to the server 4406and a response or notification from the server 4406 to the client 4404)would typically be needed to retrieve the view layout and the viewcustom options from the server 4406. The view layout and the view customoptions will be generally shown in FIG. 45 and generally described belowin the text that accompanies FIG. 45. It should be noted that each roundtrip would take up valuable computing resources and would cause timedelays. After sending the view layout and the view custom options to theclient 4404, the server 4406 would then send a response containing datato populate the view.

To improve performance, one or more view layouts and view custom optionscan be stored in the cache. Once its layout and customer options arestored in the cache, the view can generally be referred to as a cachedview. If the user navigates to a cached view, the client 4404 canretrieve the view layout and view custom options from the cache insteadof the server. By retrieving the view layout and the view custom optionsfrom the cache, a round trip to the server 4406 can be eliminated,thereby improve system performance.

FIG. 45 generally shows the structure of an exemplary cache 4416 inaccordance with one embodiment of the present invention. As shown in thefigure, the cache 4416 can include a plurality of cache entries 4518 ₁,4518 ₂, . . . , 4518 _(M), where M is a positive integer. In oneembodiment, each cache entry 4518 ₁, 4518 ₂, . . . , 4518 _(M) can bedesigned to store a layout 4520 of the view. As stated above, a view isgenerally a display panel consisting of a particular arrangement ofapplets. Accordingly, the layout of the view can generally include thelayouts 4524 ₁, 4524 ₂, . . . , 4524 _(N) of the applets associated withthe view.

In one embodiment, each cache entry 4518 ₁, 4518 ₂, . . . , 4518 _(M)can also be designed to customized options 4522 associated with theview. In one embodiment, the view customized options 4522 can includekeyboard accelerators 4526 and preferences 4528. A keyboard accelerator4526 is generally a sequence of keys or keystrokes that is mapped to acommand object. An exemplary command object is shown and generallydescribed above. Preferences 4528 are generally either default oruser-selected display options. Exemplary preferences can include font,font size, font colors, width of columns and rows, etc.

FIG. 46 generally outlines an exemplary process 4600 of caching a view.In block 4605, the client receives a request from the user to switch toa view. The client determines whether the view is currently saved in thecache (block 4610). If the view is currently not saved in the cache, theclient retrieves the view layout and the view custom options from theserver (block 4615). The view layout and the view custom options areshown in FIG. 45 and described above in the text accompanying thefigure. In block 4620, the client determines whether the cache is full.If the cache still has storage space available, the client proceeds withcaching the view. If the cache is full, the client flushes the cache toclear up storage space in the cache for the view (block 4625), thenproceeds with caching the view. The caching of the view can includecaching the view layout (block 4630). The caching of the view canfurther include caching the view custom options (block 4635).

FIG. 47 generally outlines an exemplary process 4700 of switching to aview. In block 4705, the client receives a request from the user toswitch to a view. The client determines whether the view is currentlysaved in the cache (block 4710). If the view is currently not saved inthe cache, the client retrieves the view layout and the view customoptions from the server (block 4715). It should be noted that the viewlayout and the view custom options are shown in FIG. 45 and generallydescribed above in the text accompanying the figure.

If the view is currently saved in the cache, the client retrieves theview layout and the view custom options from the cache (block 4720). Itshould be noted that the client would save a round trip to the server byretrieving the view layout and the view custom options from the cache,thereby improving system performance. After retrieving the view layoutand the view custom options, the client displays the view using the viewlayout (block 4725) and applies the view custom options to the view(4730). After displaying the view, the client retrieves data for theview from the server (block 4735). After receiving the data from theserver, the client populates fields in the view with the retrieved data(block 4740).

It should be noted that functional components, as shown above in thefigures and described in the text accompanying the figures, could beimplemented using software code segments. If the aforementionedfunctional components are implemented using software code segments,these code segments can be stored on a machine-readable medium, such asfloppy disk, hard drive, CD-ROM, DVD, tape, memory, or any storagedevice that is accessible by a computing machine.

The invention has been described in conjunction with the preferredembodiment. It is evident that numerous alternatives, modifications,variations and uses will be apparent to those skilled in the art inlight of the foregoing description.

1. A system comprising: a server, wherein the server comprises aprocessor, and a non-transitory computer-readable storage medium,coupled to the processor; a server-side object, wherein the server-sideobject is stored in the computer-readable storage medium of the server,and the server-side object is configured to be maintained at the server;an object manager (OM), the OM is configured to be executed on theprocessor of the server, and the OM is further configured to manage theserver-side object; and a synchronization mechanism, wherein thesynchronization mechanism comprises a server-side synchronizationmechanism, and a client-side synchronization mechanism, thesynchronization mechanism is configured to facilitate synchronizationbetween the server-side object, and a client-side object, by beingconfigured to invoke a method of the server-side object, in response toreceiving a remote procedure call (RPC) from the client-side object, theclient-side object is configured to be executed on a client, as part ofa graphical user interface (GUI), the client is configured to maintain acache configured to store a layout of a view, the view is a displaypanel comprising an arrangement of applets to be displayed in the GUI,and the server is configured to receive a request from the client,wherein the request indicates receipt by the client of a user request toswitch to the view, and the request comprises  the RPC configured toinvoke a method of the server-side object, and in response to thereceiving the request, if the request indicates that the layout is notstored in the cache, provide the layout to the client, wherein  thelayout is configured to be stored in the cache.
 2. The system of claim1, wherein the remote procedure call is made with blocking enabled. 3.The system of claim 1, wherein the server-side synchronization mechanismis further configured to package a response from the server-side objectinto an Hyper-Text Transfer Protocol (HTTP) response, wherein the HTTPresponse comprises a notification, status information associated withthe notification, and data associated with the notification, and sendthe HTTP response to the client-side object.
 4. The system of claim 1,wherein the client-side synchronization mechanism comprises a remoteprocedure call (RPC) mechanism, and a notification mechanism.
 5. Thesystem of claim 4, further comprising: an application object, whereinthe application object is configured to be executed on the client, andthe application object is configured to manage communications into andout of the client-side object.
 6. The system of claim 5, wherein theclient-side synchronization mechanism is configured to route anotification and data to the client-side object via the applicationobject.
 7. The system of claim 4, wherein the client is configured toobtain the layout from the server using the synchronization mechanism,and store the layout in the cache.
 8. The system of claim 1, wherein theclient-side object is a browser-side object, the browser-side object isconfigured to be executed in a browser, and the browser is configured tobe executed on a client as part of the GUI.
 9. The system of claim 1,wherein the server-side object is one of a plurality of server-sideobjects, the client-side object is one of a plurality of client-sideobjects, said server-side objects and said client-side objects are eachconfigured to execute on a respective one of a plurality of computingdevices, and the computing devices comprise the client and the server.10. The system of claim 1, wherein the client is configured to receivethe user request, wherein the user request identifies the layout,determine whether the layout is stored in the cache, if the layout isstored in the cache, retrieve the layout from the cache, and if thelayout is not stored in the cache, obtain the layout from the serverusing the synchronization mechanism, and store the layout in the cache.11. The system of claim 10, wherein the cache comprises a plurality ofcache entries, at least one cache entry of the cache entries isassociated with the layout, and the at least one cache entry isconfigured to store at least one customized option associated with thelayout.
 12. The system of claim 1, wherein the client is configured toarrange the applets in the display panel according to the layout. 13.The system of claim 1, wherein the layout defines the arrangement ofapplets in the display panel.
 14. The system of claim 1, wherein theserver is further configured to provide display data for the view, ifthe request indicates that the view is stored in the cache, and theclient is configured to populate the view with the display data.
 15. Amethod comprising: synchronizing a server-side object and a client-sideobject, wherein the synchronizing comprises receiving a request at aserver, wherein the request is from the client-side object, theclient-side object is executed on a client, the request is configured toindicate  receipt by the client of a user request to switch to a view,and  whether a layout of the view is stored in a cache at the client,the view is described by the layout, the layout is configured to bestored in the cache, the view is a display panel comprising anarrangement of applets to be displayed in the GUI, and the requestcomprises a remote procedure call (RPC) configured to invoke a method ofthe server-side object; determining whether the request indicates thatthe layout is not stored in the cache; and if the request indicates thatthe layout is not stored in the cache, retrieving the layout by  causingan object manager of a server-side synchronization mechanism to managethe server-side object by  invoking the method of the server-sideobject, wherein the object manager is executed on the server, generatinga response comprising the layout, and sending the response to theclient.
 16. The system of claim 15, further comprising: receiving theuser request at the client, wherein the user request allows the layoutto be determined, determining whether the layout is stored in the cache,if the layout is stored in the cache, retrieving the layout from thecache, and if the layout is not stored in the cache, obtaining thelayout from the server-side object by causing a client-sidesynchronization mechanism to cause the client to send the request to theserver, receiving the response, and storing the layout in the cache. 17.The system of claim 16, wherein the remote procedure call is made withblocking enabled.
 18. The system of claim 16, further comprising:creating and displaying the view using the layout; obtaining displaydata for the view from the server; and populating the view with thedisplay data.
 19. The system of claim 15, further comprising: receivingthe response at the client; causing a client-side synchronizationmechanism to route the response to the client-side object via anapplication object; and storing the layout in the cache.
 20. The systemof claim 15, wherein the generating comprises packaging the responseinto an Hyper-Text Transfer Protocol (HTTP) response, wherein the HTTPresponse comprises a notification, status information associated withthe notification, and data associated with the notification, and thesending comprises sending the HTTP response to the client-side object.21. A computer program product comprising: a non-transitorycomputer-readable storage medium; and a plurality of instructions,executable on a computer system, configured to synchronize a server-sideobject and a client-side object, wherein said instructions are encodedin said non-transitory computer-readable storage medium, and theplurality of instructions comprise a first set of instructions,executable on said computer system, configured to receive a request at aserver, wherein the request is from the client-side object, theclient-side object is executed on a client, the request is configured toindicate  receipt by the client of a user request to switch to a view,and  whether a layout of the view is stored in a cache at the client,the view is described by the layout, the layout is configured to bestored in the cache, the view is a display panel comprising anarrangement of applets to be displayed in the GUI, and the requestcomprises a remote procedure call (RPC) configured to invoke a method ofthe server-side object, a second set of instructions, executable on saidcomputer system, configured to determining whether the request indicatesthat the layout is not stored in the cache, and a third set ofinstructions, executable on said computer system, configured to, if therequest indicates that the layout is not stored in the cache, retrievethe layout by  causing an object manager of a server-sidesynchronization mechanism to manage the server-side object by  invokingthe method of the server-side object, wherein  the object manager isexecuted on the server, generate a response comprising the layout, andsend the response to the client.